FOfolk
Webhooks

Get a webhook

Changed on

Retrieve an existing webhook in the workspace.

get/v1/webhooks/{webhookId}

Request

  • Base URL
    https://api.folk.app
  • URL
    https://api.folk.app/v1/webhooks/{webhookId}
  • Auth
    HTTP bearer

Path parameters

webhookIdstring required

The ID of the webhook to retrieve.

Response

The retrieved webhook in the workspace.

deprecationsstring[]

Example response

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

Changes

  • c6818f3ba60dRevision changes
    • info

      the response property / became required for the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status