v1

latestOpenAPI 3.1.02026-07-223614164.6 KB
Webhooks

List webhooks

Retrieve a list of webhooks in the workspace.

get/v1/webhooks

Query parameters

limitinteger

The number of items to return.

cursorstring

A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the pagination.nextLink value returned in a previous response to request subsequent results.

Response

A paginated list of webhooks in the workspace.

deprecationsstring[]

Example response

{
  "data": {
    "items": [
      {
        "id": "wbk_8c18c158-d49e-4ad4-90d4-2b197688bac7",
        "name": "My app integration",
        "targetUrl": "https://my-app.com/webhook",
        "subscribedEvents": [
          {
            "eventType": "person.created",
            "filter": {}
          }
        ],
        "redactedSigningSecret": "whs_fx**********************oVMa",
        "status": "active",
        "createdAt": "2025-07-17T09:00:00.000Z"
      }
    ],
    "pagination": {
      "nextLink": "https://api.folk.app/v1/webhooks?limit=20&cursor=eyJvZmZzZXQiOjIwfQ%3D%3D"
    }
  },
  "deprecations": [
    "This field is deprecated"
  ]
}