BigCommerce Docs

mutation ExampleMutation($input: CreateEventBridgeWebhookInput) {
  createEventBridgeWebhook(input: $input) {
    webhook {
      destination
      clientId
      createdAt
      eventFilters
      id
      scope
      status
      updatedAt
    }
    errors
  }
}

{
  "input": {
    "destination": "example",
    "eventFilters": [
      {
        "dataFilter": {
          "path": [
            "example"
          ],
          "values": {
            "stringValues": [
              "example"
            ],
            "doubleValues": [
              0
            ],
            "longValues": [
              "Long"
            ]
          },
          "delivery": "IN"
        }
      }
    ],
    "isActive": true,
    "scope": "example"
  }
}

{
  "data": {
    "createEventBridgeWebhook": {
      "webhook": {
        "destination": "example",
        "clientId": "example",
        "createdAt": "DateTime",
        "eventFilters": [
          {
            "path": null,
            "values": null,
            "delivery": null
          }
        ],
        "id": "example",
        "scope": "example",
        "status": "ACTIVE",
        "updatedAt": "DateTime"
      },
      "errors": [
        {
          "message": "example"
        }
      ]
    }
  }
}

Creates an Amazon EventBridge webhook.

Arguments

inputCreateEventBridgeWebhookInputRequired

Returns

an optional CreateEventBridgeWebhookResult

errorslist of CreateEventBridgeWebhookErrors

The list of errors that occurred while creating an Amazon EventBridge webhook.

webhookEventBridgeWebhook

The result returned after creating an Amazon EventBridge webhook.

1	mutation ExampleMutation($input: CreateEventBridgeWebhookInput) {
2	createEventBridgeWebhook(input: $input) {
3	webhook {
4	destination
5	clientId
6	createdAt
7	eventFilters
8	id
9	scope
10	status
11	updatedAt
12	}
13	errors
14	}
15	}

1	{
2	"input": {
3	"destination": "example",
4	"eventFilters": [
5	{
6	"dataFilter": {
7	"path": [
8	"example"
9	],
10	"values": {
11	"stringValues": [
12	"example"
13	],
14	"doubleValues": [
15	0
16	],
17	"longValues": [
18	"Long"
19	]
20	},
21	"delivery": "IN"
22	}
23	}
24	],
25	"isActive": true,
26	"scope": "example"
27	}
28	}

1	{
2	"data": {
3	"createEventBridgeWebhook": {
4	"webhook": {
5	"destination": "example",
6	"clientId": "example",
7	"createdAt": "DateTime",
8	"eventFilters": [
9	{
10	"path": null,
11	"values": null,
12	"delivery": null
13	}
14	],
15	"id": "example",
16	"scope": "example",
17	"status": "ACTIVE",
18	"updatedAt": "DateTime"
19	},
20	"errors": [
21	{
22	"message": "example"
23	}
24	]
25	}
26	}
27	}