Webhook Configuration

Get all webhook configurations.

This endpoint returns all of your webhook configurations, keyed by webhook ID. Webhook secrets are only returned once, when a configuration is created, and are not included in this response. Event types are returned as they were supplied, so wildcard subscriptions such as v1:order.* are returned verbatim rather than expanded into individual event types.

get/api/v1/webhooks/

Request

Response

All of your webhook configurations, keyed by webhook ID. If you have no webhook configurations an empty object is returned.

GetWebhooksResponse required

A map of webhook configuration IDs to their details.

Example response

{
  "33a735f2-e68f-49b4-8192-45fb7ec50ce6": {
    "url": "https://example.com/webhooks",
    "enabled": true,
    "event_types": [
      "v1:order.*",
      "v1:product.update"
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.