Skip to main content

SubscribeRequestInput

No description

input SubscribeRequestInput {
subscriptionID: String!
responseFragment: String!
webhookUrl: URL!
webhookHeaders: JSON
}

Fields

SubscribeRequestInput.subscriptionID ● String! non-null scalar

Consumer-provided token that will be used for canceling the subscription. Should be url-safe

SubscribeRequestInput.responseFragment ● String! non-null scalar

GraphQL fragment describing fields to include in webhook response. Must inherit from one of the 3 documented subscription response types.

example: fragment OpFields on Operation { id externalId name }

SubscribeRequestInput.webhookUrl ● URL! non-null scalar

URL to POST subscription events to

SubscribeRequestInput.webhookHeaders ● JSON scalar

Headers to include in webhook callbacks ie X-API-Key: "secret"

Member Of

webhookSubscribe mutation