OBJECT

WebhookEvent

Returns the webhooks event linked to a webhook.

link GraphQL Schema definition

  • type WebhookEvent implements Node {
  • createdAt: ISO8601DateTime!
  • # The name of the event executed
  • eventName: String
  • id: ID!
  • # Invoice
  • invoice: Invoice
  • # Payload supplied as JSON that can be used to access further information of the
  • # event
  • payload: JSON
  • # Processed At
  • processedAt: ISO8601DateTime
  • # Refund Request
  • refundRequest: RefundRequest
  • # Webhook event responses
  • responses: [WebhookEventResponse!]
  • # Retry After
  • retryAfter: ISO8601DateTime
  • # Sent At
  • sentAt: ISO8601DateTime @deprecated( reason: "This field is deprecated, use "processedAt" and "status" instead. This field will be removed no later than 2024-04-01." )
  • # Shipment
  • shipment: Shipment
  • # Whether this event was skipped (only relevant if webhook has "allowSkip" set
  • # true)
  • skipped: Boolean
  • # Status
  • status: String!
  • }

link Require by