Schema  WebhookRequest
  • No results found

WebhookRequest
Object

An HTTP request to a WebhookSubscription.HTTP requests are associated with one or more WebhookAttempts representing each Event in the request body.

Fields

NameDescription
attempts*
[WebhookAttempt!]!
The list of events that were attempted to be delivered in the request body.
createDateTime*
DateTime!
The date & time the HTTP request occurred.This field has weak ordering guarantees, so it should not be used as a pagination argument.
descriptionCode*
String!
The high-level description of the HTTP request's result.Currently, four codes are defined:
  • BadResponse indicates the subscription endpoint returned a non-2xx HTTP response.
  • InvalidUrl indicates the subscription URL did not pass validation.
  • RequestTimeout indicates the subscription endpoint took more than 10 seconds to respond.
  • Success indicates the subscription endpoint returned a 2xx HTTP response.
requestId*
String!
The identifier for the HTTP request.This is included in the request as an X-Request-Id custom header.
statusCode*
Int!
The HTTP status code returned by the subscription endpoint.When an HTTP response wasn't received a synthetic status code will be generated:
  • For InvalidUrl the status code will be set to 400.
  • For RequestTimeout the status code will be set to 504.
latencyMs
Int
The latency of the HTTP request in milliseconds.This will be null if the request wasn't made (i.e. an InvalidUrl error occurred).
webhookSubscription
WebhookSubscription
The webhook subscription that was the target of the HTTP request.This will be null if the subscription has since been deleted.

Seen in

Parent nameParent typeDescription
WebhookAttemptObjectwebhookRequest field
WebhookRequestEdgeObjectnode field
webhookRequestQueryResult type