Skip to main content

webhookMessages

Retrieves a list of all webhook messages.

This query implements the GraphQL Cursor Connections Specification for paging query results with some limitations.

Limitations

  • The first and after arguments must be used together.
  • The last and before arguments must be used together.
  • If both after and before are specified then before will be ignored.
webhookMessages(
  after: String
  before: String
  first: WebhookPaginationLimit! = 50
  last: WebhookPaginationLimit! = 50
  status: WebhookMessageDeliveryStatus
  webhookSubscriptionId: ID!
): WebhookMessageConnection!

Arguments​

webhookMessages.after ● String scalar​

A cursor value used with the first argument to return the elements in the list that come after it. Optional.

This field is used to paginate through the result list.

webhookMessages.before ● String scalar​

A cursor value used with the last argument to return the elements in the list that come before it. Optional.

This field is used to paginate through the result list.

webhookMessages.first ● WebhookPaginationLimit! non-null scalar​

Specifies the number of elements to return from the list from the after cursor value. Valid values are in the range from 1 to 250. Defaults to 50.

webhookMessages.last ● WebhookPaginationLimit! non-null scalar​

Specifies the number of elements to return from the list from the before cursor value. Valid values are in the range from 1 to 250. Defaults to 50.

webhookMessages.status ● WebhookMessageDeliveryStatus enum​

Filter webhook messages based on their status. Optional.

If specified, only messages whose status matches the specified value will be returned.

webhookMessages.webhookSubscriptionId ● ID! non-null scalar​

Type​

WebhookMessageConnection object​

The connection type for WebhookMessage.