List webhook subscriptions

Lists the workspace's webhook subscriptions. searchTerm matches url and description; sortField takes name, createdAt or updatedAt. Secrets and header values are never returned. Requires: read all permission on the API.

GET
/v1/webhooks

Authorization

apiKeyAuth
x-api-key<token>

API key authentication. Create an API key in your user profile and include it in the x-api-key header.

In: header

Query Parameters

page?integer

Page number, starting at 1.

Range1 <= value <= 9007199254740991
pageSize?|||

Items per page: 5, 10, 25 or 100. Default 25.

searchTerm?string

Free-text search.

Lengthlength <= 200
sortField?string

Field to sort by.

sortDirection?string

Sort direction; requires sortField.

Value in"asc" | "desc"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://customermates.com/api/v1/webhooks"
{
  "items": [
    {
      "id": "4f3e2d1c-0b9a-4876-9543-210fedcba987",
      "url": "https://hooks.example.com/customermates",
      "description": "Sync new records to the data warehouse",
      "events": [
        "record.created",
        "record.updated"
      ],
      "bodyTemplate": null,
      "enabled": true,
      "pausedReason": null,
      "recordTrigger": null,
      "recordSources": null,
      "recordOwnerUserId": null,
      "createdAt": "2026-10-12T08:00:00.000Z",
      "updatedAt": "2026-10-12T08:00:00.000Z",
      "hasSecret": true,
      "headerNames": [
        "Authorization"
      ]
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 25,
    "totalPages": 1,
    "total": 1
  }
}
{
  "error": {
    "kind": "validation",
    "issues": [
      {
        "code": "string",
        "path": [
          "string"
        ],
        "message": "string",
        "customCode": "recordNotFound",
        "entitlement": "string"
      }
    ],
    "retryable": true
  }
}
{
  "error": {
    "kind": "validation",
    "issues": [
      {
        "code": "string",
        "path": [
          "string"
        ],
        "message": "string",
        "customCode": "recordNotFound",
        "entitlement": "string"
      }
    ],
    "retryable": true
  }
}
{
  "error": {
    "kind": "validation",
    "issues": [
      {
        "code": "string",
        "path": [
          "string"
        ],
        "message": "string",
        "customCode": "recordNotFound",
        "entitlement": "string"
      }
    ],
    "retryable": true
  }
}
{
  "error": {
    "kind": "validation",
    "issues": [
      {
        "code": "string",
        "path": [
          "string"
        ],
        "message": "string",
        "customCode": "recordNotFound",
        "entitlement": "string"
      }
    ],
    "retryable": true
  }
}
{
  "error": {
    "kind": "validation",
    "issues": [
      {
        "code": "string",
        "path": [
          "string"
        ],
        "message": "string",
        "customCode": "recordNotFound",
        "entitlement": "string"
      }
    ],
    "retryable": true
  }
}
{
  "error": {
    "kind": "validation",
    "issues": [
      {
        "code": "string",
        "path": [
          "string"
        ],
        "message": "string",
        "customCode": "recordNotFound",
        "entitlement": "string"
      }
    ],
    "retryable": true
  }
}
{
  "error": {
    "kind": "validation",
    "issues": [
      {
        "code": "string",
        "path": [
          "string"
        ],
        "message": "string",
        "customCode": "recordNotFound",
        "entitlement": "string"
      }
    ],
    "retryable": true
  }
}
Empty