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;charset=UTF-8

{
  "id" : 10,
  "url" : "http://bad-url.com",
  "state" : "enabled",
  "events" : [ "convo.assigned" ],
  "notification" : false,
  "_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:
convo.agent.reply.created
convo.assigned
convo.created
convo.customer.reply.created
convo.deleted
convo.merged
convo.moved
convo.note.created
convo.status
convo.tags
customer.created
satisfaction.ratings
notification Boolean Notification web hooks only send URI of the changed resource, not the payload body.
state String Web Hook state, one of enabled or disabled.
id Number Unique Web Hook ID
↑Back to top
© Help Scout 2019