Skip to main content

Queries

Mutations

  • activateWebhookEndpointSecret — Promote the staged pending secret to active. Subsequent deliveries are signed with it.
  • createWebhookEndpoint — Create a webhook endpoint. Returns the signing secret once. Errors if an endpoint with the same URL already exists.
  • deleteWebhookEndpoint — Delete a webhook endpoint. Returns true if an owned endpoint was deleted, false if none matched.
  • rotateWebhookEndpointSecret — Stage a new (pending) signing secret. Returns it once; add it to your receiver, then call activateWebhookEndpointSecret.
  • updateWebhookEndpoint — Update a webhook endpoint. Returns null if no endpoint with that id is owned by the caller.

Objects

  • WebhookDelivery — One event sent to one webhook endpoint, across all its attempts. Kept for 30 days. Each attempt is also in developerLog, matched by eventId.
  • WebhookEndpoint — A destination the merchant has registered to receive webhook deliveries. disabledAt is null while active.
  • WebhookSubscription — A topic an endpoint subscribes to, and the fields it is narrowed to.

Input objects

Enums