WebhookSubscription object
Represents a subscription to a webhook.
On this page
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
-
Creates a new webhook subscription.
-
Deletes a webhook subscription.
-
Updates a webhook subscription.
Implements
Deprecated fields
-
callbackUrl (
URL!
) deprecatedURL where the webhook subscription should send the POST request when the event occurs.
Deprecation warning
Use
endpoint
instead
Represents a subscription to a webhook.
On this page
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
-
Creates a new webhook subscription.
-
Deletes a webhook subscription.
-
Updates a webhook subscription.
Implements
Deprecated fields
-
callbackUrl (
URL!
) deprecatedURL where the webhook subscription should send the POST request when the event occurs.
Deprecation warning
Use
endpoint
instead
Represents a subscription to a webhook.
On this page
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
-
Creates a new webhook subscription.
-
Deletes a webhook subscription.
-
Updates a webhook subscription.
Implements
Deprecated fields
-
callbackUrl (
URL!
) deprecatedURL where the webhook subscription should send the POST request when the event occurs.
Deprecation warning
Use
endpoint
instead
Represents a subscription to a webhook.
On this page
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
-
Creates a new webhook subscription.
-
Deletes a webhook subscription.
-
Updates a webhook subscription.
Implements
Deprecated fields
-
callbackUrl (
URL!
) deprecatedURL where the webhook subscription should send the POST request when the event occurs.
Deprecation warning
Use
endpoint
instead
Represents a subscription to a webhook.
On this page
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
-
Creates a new webhook subscription.
-
Deletes a webhook subscription.
-
Updates a webhook subscription.
Implements
Deprecated fields
-
callbackUrl (
URL!
) deprecatedURL where the webhook subscription should send the POST request when the event occurs.
Deprecation warning
Use
endpoint
instead
Represents a subscription to a webhook.
On this page
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
-
Creates a new webhook subscription.
-
Deletes a webhook subscription.
-
Updates a webhook subscription.
Implements
Deprecated fields
-
callbackUrl (
URL!
) deprecatedURL where the webhook subscription should send the POST request when the event occurs.
Deprecation warning
Use
endpoint
instead
Represents a subscription to a webhook.
On this page
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
-
Creates a new webhook subscription.
-
Deletes a webhook subscription.
-
Updates a webhook subscription.
Implements
Deprecated fields
-
callbackUrl (
URL!
) deprecatedURL where the webhook subscription should send the POST request when the event occurs.
Deprecation warning
Use
endpoint
instead
Represents a subscription to a webhook.
On this page
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
-
Creates a new webhook subscription.
-
Deletes a webhook subscription.
-
Updates a webhook subscription.
Implements
Deprecated fields
-
callbackUrl (
URL!
) deprecatedURL where the webhook subscription should send the POST request when the event occurs.
Deprecation warning
Use
endpoint
instead
Represents a subscription to a webhook.
On this page
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
-
Creates a new webhook subscription.
-
Deletes a webhook subscription.
-
Updates a webhook subscription.
Implements
Deprecated fields
-
callbackUrl (
URL!
) deprecatedURL where the webhook subscription should send the POST request when the event occurs.
Deprecation warning
Use
endpoint
instead
Represents a subscription to a webhook.
On this page
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
-
Creates a new webhook subscription.
-
Deletes a webhook subscription.
-
Updates a webhook subscription.
Implements
Deprecated fields
-
callbackUrl (
URL!
) deprecatedURL where the webhook subscription should send the POST request when the event occurs.
Deprecation warning
Use
endpoint
instead
Represents a subscription to a webhook.
On this page
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
-
Creates a new webhook subscription.
-
Deletes a webhook subscription.
-
Updates a webhook subscription.
Implements
Deprecated fields
-
callbackUrl (
URL!
) deprecatedURL where the webhook subscription should send the POST request when the event occurs.
Deprecation warning
Use
endpoint
instead