Skip to main content

Data Structure

CreateWebhookSubscriptionInput

An input object for WebhookSubscription creation

Mutations

createWebhookSubscription

Creates a new webhook subscription for a given event type by CreateWebhookSubscriptionInput input object. Once created, the subscription becomes active and will receive event payloads when the specified event is triggered.
  • The API user context must have AUTHENTICATED scope to access webhook subscriptions. Anonymous users cannot retrieve this data.
  • The API user context must have permission to create webhook subscriptions.
  • The API user context must be present and valid - otherwise, access is denied.
The following arguments can be used in the mutation:
The createWebhookSubscription mutation supports the same advanced features as other mutations:

Authentication

Understand the authentication requirements and how to properly authenticate your requests.
Common error scenarios and solutions:
  • 401 Unauthorized: Ensure you’re using a valid authentication token with AUTHENTICATED scope
  • 403 Forbidden: Verify your user account has the necessary permissions to access webhook subscription data