v2

latestOpenAPI 3.0.02026-07-3139594346.4 KB

Webhooks

Get Webhook

Get Webhook information by its Webhook ID. Results only include webhooks authorized by the X-API-Key.

get/v1/webhooks/{webhook_id}

Path parameters

webhook_idstring required

A unique webhook ID. Reference this value to modify or delete the webhook subscription. operations as well.

Example:wh_za7VbYcSQU2zRgGQXQAm-g

Webhook ID

Response

Success

created_atinteger required

Webhook creation time in epoch timestamp milliseconds.

event_group'all' | 'null' nullable

Subscribe to a group of events. all: subscribe to all existing and future event types

eventsWebhooksType[] nullable

All events the webhook is subscribed to. Null when event_group = all.

urlstring required

The full URL to receive webhook notifications.

webhook_idstring required

A unique webhook ID. Reference this value to modify or delete the webhook subscription. operations as well.

Example response

{
  "created_at": 1485997169003,
  "events": [
    "pending"
  ],
  "url": "https://eva-nerv.shop.com/path/to/hook",
  "webhook_id": "wh_za7VbYcSQU2zRgGQXQAm-g"
}