API version: unstable
API version: 2021-01 Release candidate
API version: 2020-10 Latest
API version: 2020-07
API version: 2020-04
API version: 2020-01
API version: 2019-10 Unsupported
API version: 2019-07 Unsupported

WebhookSubscription object

Version unstable

Represents a subscription to a webhook.

Fields

createdAt (DateTime!)

The date and time when the webhook subscription was created.

endpoint (WebhookSubscriptionEndpoint!)

Endpoint where webhooks will be delivered to.

format (WebhookSubscriptionFormat!)

The format in which the webhook subscription should send the data.

id (ID!)

Globally unique identifier.

includeFields ([String!]!)

The list of fields to be included in the webhook subscription.

legacyResourceId (UnsignedInt64!)

The ID of the corresponding resource in the REST Admin API.

metafieldNamespaces ([String!]!)

The list of namespaces for any metafields that should be included in the webhook subscription.

topic (WebhookSubscriptionTopic!)

The type of event that triggers the webhook.

updatedAt (DateTime!)

The date and time when the webhook subscription was updated.

Types that return WebhookSubscription

Mutations for WebhookSubscription

webhookSubscriptionCreate

Creates a new webhook subscription.

webhookSubscriptionDelete

Deletes a webhook subscription.

webhookSubscriptionUpdate

Updates a webhook subscription.

Implements

Deprecated fields

callbackUrl (URL!) deprecated

URL where the webhook subscription should send the POST request when the event occurs.

Deprecation warning

Use endpoint instead

Version 2021-01 (Release candidate)

Represents a subscription to a webhook.

Fields

createdAt (DateTime!)

The date and time when the webhook subscription was created.

endpoint (WebhookSubscriptionEndpoint!)

Endpoint where webhooks will be delivered to.

format (WebhookSubscriptionFormat!)

The format in which the webhook subscription should send the data.

id (ID!)

Globally unique identifier.

includeFields ([String!]!)

The list of fields to be included in the webhook subscription.

legacyResourceId (UnsignedInt64!)

The ID of the corresponding resource in the REST Admin API.

metafieldNamespaces ([String!]!)

The list of namespaces for any metafields that should be included in the webhook subscription.

topic (WebhookSubscriptionTopic!)

The type of event that triggers the webhook.

updatedAt (DateTime!)

The date and time when the webhook subscription was updated.

Types that return WebhookSubscription

Mutations for WebhookSubscription

webhookSubscriptionCreate

Creates a new webhook subscription.

webhookSubscriptionDelete

Deletes a webhook subscription.

webhookSubscriptionUpdate

Updates a webhook subscription.

Implements

Deprecated fields

callbackUrl (URL!) deprecated

URL where the webhook subscription should send the POST request when the event occurs.

Deprecation warning

Use endpoint instead

Version 2020-10 (Latest)

Represents a subscription to a webhook.

Fields

createdAt (DateTime!)

The date and time when the webhook subscription was created.

endpoint (WebhookSubscriptionEndpoint!)

Endpoint where webhooks will be delivered to.

format (WebhookSubscriptionFormat!)

The format in which the webhook subscription should send the data.

id (ID!)

Globally unique identifier.

includeFields ([String!]!)

The list of fields to be included in the webhook subscription.

legacyResourceId (UnsignedInt64!)

The ID of the corresponding resource in the REST Admin API.

metafieldNamespaces ([String!]!)

The list of namespaces for any metafields that should be included in the webhook subscription.

topic (WebhookSubscriptionTopic!)

The type of event that triggers the webhook.

updatedAt (DateTime!)

The date and time when the webhook subscription was updated.

Types that return WebhookSubscription

Mutations for WebhookSubscription

webhookSubscriptionCreate

Creates a new webhook subscription.

webhookSubscriptionDelete

Deletes a webhook subscription.

webhookSubscriptionUpdate

Updates a webhook subscription.

Implements

Deprecated fields

callbackUrl (URL!) deprecated

URL where the webhook subscription should send the POST request when the event occurs.

Deprecation warning

Use endpoint instead

Version 2020-07

Represents a subscription to a webhook.

Fields

createdAt (DateTime!)

The date and time when the webhook subscription was created.

endpoint (WebhookSubscriptionEndpoint!)

Endpoint where webhooks will be delivered to.

format (WebhookSubscriptionFormat!)

The format in which the webhook subscription should send the data.

id (ID!)

Globally unique identifier.

includeFields ([String!]!)

The list of fields to be included in the webhook subscription.

legacyResourceId (UnsignedInt64!)

The ID of the corresponding resource in the REST Admin API.

metafieldNamespaces ([String!]!)

The list of namespaces for any metafields that should be included in the webhook subscription.

topic (WebhookSubscriptionTopic!)

The type of event that triggers the webhook.

updatedAt (DateTime!)

The date and time when the webhook subscription was updated.

Types that return WebhookSubscription

Mutations for WebhookSubscription

webhookSubscriptionCreate

Creates a new webhook subscription.

webhookSubscriptionDelete

Deletes a webhook subscription.

webhookSubscriptionUpdate

Updates a webhook subscription.

Implements

Deprecated fields

callbackUrl (URL!) deprecated

URL where the webhook subscription should send the POST request when the event occurs.

Deprecation warning

Use endpoint instead

Version 2020-04

Represents a subscription to a webhook.

Fields

createdAt (DateTime!)

The date and time when the webhook subscription was created.

format (WebhookSubscriptionFormat!)

The format in which the webhook subscription should send the data.

id (ID!)

Globally unique identifier.

includeFields ([String!]!)

The list of fields to be included in the webhook subscription.

legacyResourceId (UnsignedInt64!)

The ID of the corresponding resource in the REST Admin API.

metafieldNamespaces ([String!]!)

The list of namespaces for any metafields that should be included in the webhook subscription.

topic (WebhookSubscriptionTopic!)

The type of event that triggers the webhook.

updatedAt (DateTime!)

The date and time when the webhook subscription was updated.

Types that return WebhookSubscription

Mutations for WebhookSubscription

webhookSubscriptionCreate

Creates a new webhook subscription.

webhookSubscriptionDelete

Deletes a webhook subscription.

webhookSubscriptionUpdate

Updates a webhook subscription.

Implements

Deprecated fields

callbackUrl (URL!) deprecated

URL where the webhook subscription should send the POST request when the event occurs.

Deprecation warning

Use endpoint instead

Version 2020-01

Represents a subscription to a webhook.

Fields

createdAt (DateTime!)

The date and time when the webhook subscription was created.

format (WebhookSubscriptionFormat!)

The format in which the webhook subscription should send the data.

id (ID!)

Globally unique identifier.

includeFields ([String!]!)

The list of fields to be included in the webhook subscription.

legacyResourceId (UnsignedInt64!)

The ID of the corresponding resource in the REST Admin API.

metafieldNamespaces ([String!]!)

The list of namespaces for any metafields that should be included in the webhook subscription.

topic (WebhookSubscriptionTopic!)

The type of event that triggers the webhook.

updatedAt (DateTime!)

The date and time when the webhook subscription was updated.

Types that return WebhookSubscription

Mutations for WebhookSubscription

webhookSubscriptionCreate

Creates a new webhook subscription.

webhookSubscriptionDelete

Deletes a webhook subscription.

webhookSubscriptionUpdate

Updates a webhook subscription.

Implements

Deprecated fields

callbackUrl (URL!) deprecated

URL where the webhook subscription should send the POST request when the event occurs.

Deprecation warning

Use endpoint instead

Version 2019-10 (Unsupported)

Represents a subscription to a webhook.

Fields

createdAt (DateTime!)

The date and time when the webhook subscription was created.

format (WebhookSubscriptionFormat!)

The format in which the webhook subscription should send the data.

id (ID!)

Globally unique identifier.

includeFields ([String!]!)

The list of fields to be included in the webhook subscription.

legacyResourceId (UnsignedInt64!)

The ID of the corresponding resource in the REST Admin API.

metafieldNamespaces ([String!]!)

The list of namespaces for any metafields that should be included in the webhook subscription.

topic (WebhookSubscriptionTopic!)

The type of event that triggers the webhook.

updatedAt (DateTime!)

The date and time when the webhook subscription was updated.

Types that return WebhookSubscription

Mutations for WebhookSubscription

webhookSubscriptionCreate

Creates a new webhook subscription.

webhookSubscriptionDelete

Deletes a webhook subscription.

webhookSubscriptionUpdate

Updates a webhook subscription.

Implements

Deprecated fields

callbackUrl (URL!) deprecated

URL where the webhook subscription should send the POST request when the event occurs.

Deprecation warning

Use endpoint instead

Version 2019-07 (Unsupported)

Represents a subscription to a webhook.

Fields

createdAt (DateTime!)

The date and time when the webhook subscription was created.

format (WebhookSubscriptionFormat!)

The format in which the webhook subscription should send the data.

id (ID!)

Globally unique identifier.

includeFields ([String!]!)

The list of fields to be included in the webhook subscription.

legacyResourceId (UnsignedInt64!)

The ID of the corresponding resource in the REST Admin API.

metafieldNamespaces ([String!]!)

The list of namespaces for any metafields that should be included in the webhook subscription.

topic (WebhookSubscriptionTopic!)

The type of event that triggers the webhook.

updatedAt (DateTime!)

The date and time when the webhook subscription was updated.

Types that return WebhookSubscription

Mutations for WebhookSubscription

webhookSubscriptionCreate

Creates a new webhook subscription.

webhookSubscriptionDelete

Deletes a webhook subscription.

webhookSubscriptionUpdate

Updates a webhook subscription.

Implements

Deprecated fields

callbackUrl (URL!) deprecated

URL where the webhook subscription should send the POST request when the event occurs.

Deprecation warning

Use endpoint instead

Version 2019-04 (Unsupported)

Represents a subscription to a webhook.

Fields

createdAt (DateTime!)

The date and time when the webhook subscription was created.

format (WebhookSubscriptionFormat!)

The format in which the webhook subscription should send the data.

id (ID!)

Globally unique identifier.

includeFields ([String!]!)

The list of fields to be included in the webhook subscription.

legacyResourceId (UnsignedInt64!)

The ID of the corresponding resource in the REST Admin API.

metafieldNamespaces ([String!]!)

The list of namespaces for any metafields that should be included in the webhook subscription.

topic (WebhookSubscriptionTopic!)

The type of event that triggers the webhook.

updatedAt (DateTime!)

The date and time when the webhook subscription was updated.

Types that return WebhookSubscription

Mutations for WebhookSubscription

webhookSubscriptionCreate

Creates a new webhook subscription.

webhookSubscriptionDelete

Deletes a webhook subscription.

webhookSubscriptionUpdate

Updates a webhook subscription.

Implements

Deprecated fields

callbackUrl (URL!) deprecated

URL where the webhook subscription should send the POST request when the event occurs.

Deprecation warning

Use endpoint instead

Samples