Sign in to run requests with your own sandbox key. Sign in

WebhookSubscriptionCreateRequest

Type: WebhookSubscriptionCreateRequest

WebhookSubscriptionCreateRequest has 3 top-level fields; url is always present. Fields typed as another schema link to that schema's page, and nested objects expand in place below. It is referenced by 1 operation, listed under Used by. The machine-readable definition is #/components/schemas/WebhookSubscriptionCreateRequest in openapi.json; the example in the right-hand rail is synthesized from the field examples in that spec.

Fields

  • url string (uri) required HTTPS endpoint. Must resolve to a public address (no private, loopback or cloud-metadata ranges).
  • event_filter array of WebhookEventName Events to receive. Omit or pass `[]` for all events; unknown names return `422`.
  • active boolean

Used by

Was this page helpful?