Skip to main content

Get (just) all (deleted) Webhooks

GET 
/webhook/:type
deprecated

Returns all Webhooks of the requested Company. When the Company has no Webhooks an empty array will be returned. The "trashed" operation returns all Webhooks including deleted Webhooks. The "justtrashed" operation returns only the deleted Webhooks.

Note, "normal" will yield the same result as without a type.

Request​

Path Parameters

    type stringrequired

    Possible values: [normal, trashed, justtrashed]

    Type of operations for querying deleted Webhooks.

    "normal"
    Returns all the Webhooks except those which are deleted.
    "trashed"
    Returns all the Webhooks including those which are deleted.
    "justtrashed"
    Returns all and only the deleted Webhooks.

Responses​

Webhooks found.

Schema

  • Array [

    • 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...