Docs
Dashboard

WebhookSubscription

Object

Fields returned for webhook subscription.

#

Fields


deliveries
WebhookDeliveryConnection!

Retrieves a paged list of webhook deliveries associated with the webhook subscription.

id
ID!

Get the unique identifier of the webhook subscription.

isActive
Boolean!

Indicates whether the webhook subscription is currently active.

secret
String!

Get the secret of the webhook subscription.

subscribedEvents
[WebhookEventType!]!

Get the events the webhook subscription is subscribed to.

Possible enum values
  • CUSTOMER_ACTIVATED

    A customer account was activated.

  • CUSTOMER_CREATED

    A customer was created.

  • CUSTOMER_DELETED

    A customer was deleted.

  • CUSTOMER_EMAIL_CONFIRMATION_TOKEN

    A customer email-confirmation flow requires notification.

  • CUSTOMER_PASSWORD_RESET_TOKEN

    A customer password-reset flow requires notification.

  • CUSTOMER_UPDATED

    A customer was updated.

  • ORDER_CREATED

    An order was created.

  • ORDER_PAYMENT_STATE_CHANGED

    An order's payment state changed.

  • ORDER_UPDATED

    An order was updated.

  • PRODUCT_CREATED

    A product was created.

  • PRODUCT_DELETED

    A product was deleted.

  • PRODUCT_UPDATED

    A product was updated.

url
String!

Get the URL of the webhook subscription.

#

Queries


Retrieves a webhook subscription by its unique identifier.

Retrieves a paged list of webhook subscriptions.

#

Mutations


Creates a new webhook subscription with the provided details.

Updates an existing webhook subscription with the provided details.