Skip to main content
GET
/
v1
/
webhooks
/
{webhookId}
Get a webhook
curl --request GET \
  --url https://api.folk.app/v1/webhooks/{webhookId} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "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"
  }
}
Retrieve an existing webhook in the workspace. To learn more about webhooks, how to set them up and receive notifications, check out the webhooks guide.

Authorizations

​
Authorization
string
header
required

API key for authentication

Path Parameters

​
webhookId
string
required

The ID of the webhook to retrieve.

Required string length: 40

Response

The retrieved webhook in the workspace.

​
data
object
required

A webhook listening to events from the workspace and sending them to a URL.

Example:
{
  "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"
}
​
deprecations
string[]
Example:
["This field is deprecated"]