List webhooks

GET

/api/v1/tenants/{tenant_id}/workspaces/{workspace_id}/webhooks

List all webhook subscriptions.

Authorizations

• HTTPBearer
• HTTPBearer

Parameters

Header Parameters

X-Workspace-ID

Any of:

string

string

null

null

X-API-Key

Any of:

string

string

null

null

X-Tenant-ID

Any of:

string

string

null

null

Responses

200

Successful Response

Examples

Webhook list response

{
  "items": [
    {
      "id": "f2f07352-1259-4a10-9fe3-2234f0ebdf8a",
      "url": "https://erp.obs.ng/integrations/zutax/webhooks",
      "events": [
        "invoice.validated",
        "invoice.dispatched",
        "credit_note.dispatched"
      ],
      "is_active": true
    }
  ],
  "total": 1
}

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Examples

422 response example

{
  "detail": [
    {
      "loc": [],
      "msg": "string",
      "type": "string"
    }
  ]
}