eventBridgeWebhookSubscriptionCreate mutation
Creates a new Amazon EventBridge webhook subscription.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
topic
(
WebhookSubscriptionTopic!
)
required
|
The type of event that triggers the webhook. |
webhookSubscription
(
EventBridgeWebhookSubscriptionInput!
)
required
|
Specifies the input fields for an EventBridge webhook subscription. |
EventBridgeWebhookSubscriptionInput fields
-
arn (
ARN
)ARN of the EventBridge event source.
-
format (
WebhookSubscriptionFormat
)The format in which the webhook subscription should send the data.
-
includeFields (
[String!]
)The list of fields to be included in the webhook subscription.
-
metafieldNamespaces (
[String!]
)The list of namespaces for any metafields that should be included in the webhook subscription.
Return fields
-
userErrors (
[UserError!]!
)List of errors that occurred executing the mutation.
-
webhookSubscription (
WebhookSubscription
)The webhook subscription that was created.
Creates a new Amazon EventBridge webhook subscription.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
topic
(
WebhookSubscriptionTopic!
)
required
|
The type of event that triggers the webhook. |
webhookSubscription
(
EventBridgeWebhookSubscriptionInput!
)
required
|
Specifies the input fields for an EventBridge webhook subscription. |
EventBridgeWebhookSubscriptionInput fields
-
arn (
ARN
)ARN of the EventBridge event source.
-
format (
WebhookSubscriptionFormat
)The format in which the webhook subscription should send the data.
-
includeFields (
[String!]
)The list of fields to be included in the webhook subscription.
-
metafieldNamespaces (
[String!]
)The list of namespaces for any metafields that should be included in the webhook subscription.
Return fields
-
userErrors (
[UserError!]!
)List of errors that occurred executing the mutation.
-
webhookSubscription (
WebhookSubscription
)The webhook subscription that was created.
Creates a new Amazon EventBridge webhook subscription.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
topic
(
WebhookSubscriptionTopic!
)
required
|
The type of event that triggers the webhook. |
webhookSubscription
(
EventBridgeWebhookSubscriptionInput!
)
required
|
Specifies the input fields for an EventBridge webhook subscription. |
EventBridgeWebhookSubscriptionInput fields
-
arn (
ARN
)ARN of the EventBridge event source.
-
format (
WebhookSubscriptionFormat
)The format in which the webhook subscription should send the data.
-
includeFields (
[String!]
)The list of fields to be included in the webhook subscription.
-
metafieldNamespaces (
[String!]
)The list of namespaces for any metafields that should be included in the webhook subscription.
Return fields
-
userErrors (
[UserError!]!
)List of errors that occurred executing the mutation.
-
webhookSubscription (
WebhookSubscription
)The webhook subscription that was created.
Creates a new Amazon EventBridge webhook subscription.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
topic
(
WebhookSubscriptionTopic!
)
required
|
The type of event that triggers the webhook. |
webhookSubscription
(
EventBridgeWebhookSubscriptionInput!
)
required
|
Specifies the input fields for an EventBridge webhook subscription. |
EventBridgeWebhookSubscriptionInput fields
-
arn (
ARN
)ARN of the EventBridge event source.
-
format (
WebhookSubscriptionFormat
)The format in which the webhook subscription should send the data.
-
includeFields (
[String!]
)The list of fields to be included in the webhook subscription.
-
metafieldNamespaces (
[String!]
)The list of namespaces for any metafields that should be included in the webhook subscription.
Return fields
-
userErrors (
[UserError!]!
)List of errors that occurred executing the mutation.
-
webhookSubscription (
WebhookSubscription
)The webhook subscription that was created.
Creates a new Amazon EventBridge webhook subscription.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
topic
(
WebhookSubscriptionTopic!
)
required
|
The type of event that triggers the webhook. |
webhookSubscription
(
EventBridgeWebhookSubscriptionInput!
)
required
|
Specifies the input fields for an EventBridge webhook subscription. |
EventBridgeWebhookSubscriptionInput fields
-
arn (
ARN
)ARN of the EventBridge event source.
-
format (
WebhookSubscriptionFormat
)The format in which the webhook subscription should send the data.
-
includeFields (
[String!]
)The list of fields to be included in the webhook subscription.
-
metafieldNamespaces (
[String!]
)The list of namespaces for any metafields that should be included in the webhook subscription.
Return fields
-
userErrors (
[UserError!]!
)List of errors that occurred executing the mutation.
-
webhookSubscription (
WebhookSubscription
)The webhook subscription that was created.
Creates a new Amazon EventBridge webhook subscription.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
topic
(
WebhookSubscriptionTopic!
)
required
|
The type of event that triggers the webhook. |
webhookSubscription
(
EventBridgeWebhookSubscriptionInput!
)
required
|
Specifies the input fields for an EventBridge webhook subscription. |
EventBridgeWebhookSubscriptionInput fields
-
arn (
ARN
)ARN of the EventBridge event source.
-
format (
WebhookSubscriptionFormat
)The format in which the webhook subscription should send the data.
-
includeFields (
[String!]
)The list of fields to be included in the webhook subscription.
-
metafieldNamespaces (
[String!]
)The list of namespaces for any metafields that should be included in the webhook subscription.
Return fields
-
userErrors (
[UserError!]!
)List of errors that occurred executing the mutation.
-
webhookSubscription (
WebhookSubscription
)The webhook subscription that was created.