Sign in
latestOpenAPI 3.0.12026-08-101292701.1 MB

f21981db32be

Webhooks

Gets a webhook endpoint by ID

Retrieves the details of a webhook endpoint. Supply the unique identifier of the webhook endpoint.

get/webhooks/{id}

Path parameters

idstring required

Webhook ID

Response

200 OK. Returns an event object if a valid identifier was provided. All events share a common structure. The only property that will differ is the data property. The data dictionary's values will be the same as retrieving the same object directly from the API. For example, a charge.created event will have the same information as retrieving the relevant charge would.

idstring uuid
createdTimestring date-time

Time at which the webhook was created

updatedTimestring date-time

Time at which the webhook was updated

typesstring[]
apiVersion'default' | '<YYYY-MM-DD>'

Indicates whether the webhook is configured for the current, default version of the API or the version specified by YYYY-MM-DD.

enabledboolean

Indicate that webhook is enabled and receives notifications or is not enabled and does not receive notifications

addressstring

URL of the webhook endpoint on your server you have set up to receive webhook notifications. Webhook data is sent as JSON in the POST request body. The full event details are included and can be used directly, after parsing the JSON into an Event object.

transportType'HTTP' | 'OAUTH'

Example response

{
  "createdTime": "2018-08-29T09:12:33.001Z",
  "updatedTime": "2018-08-29T09:12:33.001Z",
  "types": [
    "order.created"
  ],
  "apiVersion": "default",
  "enabled": true,
  "address": "https://company.com"
}