Get Webhook
Request
GET /v2/webhooks/10 HTTP/1.1
Authorization: Bearer oauth_token
Path Parameters
/v2/webhooks/{webhookId}
Response
HTTP/1.1 200 OK
Content-Type: application/hal+json
{
"id" : 10,
"url" : "http://bad-url.com",
"state" : "enabled",
"events" : [ "convo.assigned" ],
"notification" : false,
"payloadVersion" : "V2",
"label" : "cool webhook",
"mailboxIds" : [ ],
"_links" : {
"self" : {
"href" : "..."
}
}
}
Response fields
Path | Type | Description |
---|---|---|
url |
String |
URL that will be called when of the events occurs |
events |
Array |
List of defined events, one of:beacon.chat.created beacon.chat.customer.replied convo.agent.reply.created convo.assigned convo.created convo.custom-fields convo.customer.reply.created convo.deleted convo.merged convo.moved convo.note.created convo.status convo.tags customer.created customer.deleted customer.updated message.survey.response.received satisfaction.ratings tag.created tag.deleted tag.updated |
notification |
Boolean |
Notification web hooks only send URI of the changed resource, not the payload body. |
label |
String |
Label associated with this Webhook for better clarity. |
payloadVersion |
String |
Version of the payload delivered to the url . Only option is V2 and can be omitted because it’s the default. |
mailboxIds |
Array |
An array of mailbox identifiers. The webhook will trigger for actions on conversations in any of the specified mailboxes. If not provided, the webhook will trigger for actions on conversations in all mailboxes. |
state |
String |
Web Hook state, one of enabled or disabled . |
id |
Number |
Unique Web Hook ID |