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",
  "_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
satisfaction.ratings
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, one of
V1
V2
V1 is modelled after Mailbox API 1.0 and should not be used, because it will be phased out eventually.
V2 is modelled after Mailbox API 2.0 and it’s the preferred version. The default version (used when the field is omitted in the request) is V1 for the time being in order not be break the API by adding this new field.
state String Web Hook state, one of enabled or disabled.
id Number Unique Web Hook ID
↑Back to top
© Help Scout 2021