BigCommerce Docs

mutation ExampleMutation($input: CreateHttpsWebhookInput) {
  createHttpsWebhook(input: $input) {
    webhook {
      destination
      headers
      clientId
      createdAt
      eventFilters
      id
      scope
      status
      updatedAt
    }
    errors
  }
}

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

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

mutation ExampleMutation($input: CreateHttpsWebhookInput) {
  createHttpsWebhook(input: $input) {
    webhook {
      destination
      headers
      clientId
      createdAt
      eventFilters
      id
      scope
      status
      updatedAt
    }
    errors
  }
}

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

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

Creates an HTTPS webhook.

Arguments

inputCreateHttpsWebhookInputRequired

Returns

an optional CreateHttpsWebhookResult

errorslist of CreateHttpsWebhookErrors

The list of errors that occurred while creating a HTTPS webhook.

webhookHttpsWebhook

The webhook object returned as a result of a mutation.

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	"headers": [
26	{
27	"key": "example",
28	"value": "example"
29	}
30	],
31	"isActive": true,
32	"scope": "example"
33	}
34	}

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

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	"headers": [
26	{
27	"key": "example",
28	"value": "example"
29	}
30	],
31	"isActive": true,
32	"scope": "example"
33	}
34	}

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

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