Skip to main content

Create a Webhook

POST 
/webhook
deprecated

Creates a new Webhook and attaches it to the requested Company. A WebhookEvent stops broadcasting when it gets 200 a response.

Request​

Body

Input data

    event stringrequired

    Possible values: [order-updated, order-pending, order-paid, order-cancelled]

    The trigger that will invoke the Webhook.

    url urlrequired

    Possible values: <= 65535 characters

    The url to which to make POST request(s) after a trigger of the event. Only if a request fails, there can be a retry.

Responses​

Webhook created.

Schema

    guid uuidrequired

    The guid of the Webhook.

    event stringrequired

    Possible values: [order-updated, order-pending, order-paid, order-cancelled]

    The trigger that will invoke the Webhook.

    url urlrequired

    Possible values: <= 65535 characters

    The url to which to make POST request(s) after a trigger of the event. Only if a request fails, there can be a retry.

    created_at ISO 8601

    The time it was created.

    updated_at ISO 8601

    The time it was last updated.

Loading...