WebhookDelivery

Object

Fields returned for webhook delivery.

Fields

attemptCount Int!: The attempt count of the webhook delivery.
errorMessage String: The error message of the webhook delivery.
eventType WebhookEventType!: The type of event that triggered the webhook delivery
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.
id ID!: The unique identifier of the webhook delivery.
idempotencyKey String!: The idempotency key of the webhook delivery.
payload String!: The payload of the webhook delivery.
requestedAt DateTime!: The timestamp when the webhook request was sent.
response String: The response of the webhook delivery.
responseReceivedAt DateTime: The timestamp when the webhook response was received.
status WebhookDeliveryStatus!: The status of the webhook delivery.
Possible enum values
FAILED
The delivery attempt did not succeed.
PENDING
The delivery is waiting to be attempted.
RETRYING
Another delivery attempt is scheduled or in progress.
SUCCESS
The destination accepted the delivery.
TIMEOUT
The destination did not respond within the allowed time.
statusCode Int!: The HTTP status code returned for the webhook delivery.

Queries

webhookDelivery: Retrieves a webhook delivery by its unique identifier.

Mutations

webhookDeliveryResend: Resends a failed webhook delivery with the same idempotency key.