Data Structure
CreateWebhookSubscriptionInput
An input object forWebhookSubscription 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
AUTHENTICATEDscope 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.
Related Features
ThecreateWebhookSubscription mutation supports the same advanced features as other mutations:
Authentication
Understand the authentication requirements and how to properly authenticate your requests.
Authentication Errors
Authentication Errors
- 401 Unauthorized: Ensure you’re using a valid authentication token with
AUTHENTICATEDscope - 403 Forbidden: Verify your user account has the necessary permissions to access webhook subscription data