Get all Webhooks

GET 
/webhook

deprecated

Returns all Webhooks of the requested Company. When the Company has no Webhooks an empty array will be returned.

Request

Responses

200

Webhooks found.

application/json

Schema

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.

• ]

Example (from schema)

[
  {
    "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "event": "order-updated",
    "url": "string",
    "created_at": "string",
    "updated_at": "string"
  }
]

403

Unauthorized. You do not have permission to manage Webhooks of the Company.

application/json

Schema

Schema

error_code string

The general error code.

error_description stringrequired

The exact reason of failure.

Example (from schema)

{
  "error_code": "string",
  "error_description": "string"
}

404

Company not found.

application/json

Schema

Schema

error_code string

The general error code.

error_description stringrequired

The exact reason of failure.

Example (from schema)

{
  "error_code": "string",
  "error_description": "string"
}

Loading...