Overview

Genesys Cloud webhooks post a notification about an external event into a group chat room. Genesys Cloud includes several preconfigured integrations, including Jenkins, JIRA, Bitbucket, GitHub, and Salesforce. For details about how to configure a webhook, see About webhook integrations.

Once you configure the webhook, you can send an event using a REST POST command with event details. This POST can originate from any external system and does not require authentication.

The content of a POST message is as follows:

{
  "message": "This message will show in the chat",
  "metadata": "Extra info used for filtering"
}

The following is a full example using cURL:

curl -H "Content-Type: application/json" -X POST -d '{"message":"This message will show in a chat","metadata":"example"}' https://apps.mypurecloud.com:443/webhooks/api/v1/webhook/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee

Webhook messages support markdown for richer notifications, as follows:

{
  "message": "Webhooks support [markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) so you can add **bold**, _italic_, links\n\n new lines embedded images and more ![image](http://developer.mypurecloud.com/images/Logo.png)",
  "metadata": "example"
}

This message produces the following webhook notification: