Sign in
latestOpenAPI 3.0.12026-08-101292701.1 MB

f21981db32be

Webhooks

Returns a list of webhooks

Get all webhooks.

get/webhooks

Query parameters

typestring

A string containing a specific webhook endpoint name, or a group of events using * as a wildcard. The list will be filtered to include only webhooks with a matching webhook property.

typesstring

An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property. You may pass either type or types, but not both.

Response

200 OK. A dictionary with a data property that contains an array of up to limit webhooks. Each entry in the array is a separate webhook object. If no more webhooks are available, the resulting array will be empty. This request should never return an error.

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"
  }
]