FOfolk
Webhooks

Create a webhook

Changed on

Creates a new webhook listening to workspace events.

post/v1/webhooks

Request

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

Headers

Idempotency-Keystring

A unique key, such as a UUID, that makes retrying this request safe: a retry with the same key and body returns the original response without running the operation again. Keys are kept for 24 hours after the request completes.

Example:8e03978e-40d5-43e8-bc93-6894a57f9324

Request body

namestring required

A friendly name for the webhook.

targetUrlstring uri required

The URL of the webhook. It must be a publicly accessible URL using the HTTP or HTTPS protocol.

Example request

{
  "name": "My app integration",
  "targetUrl": "https://my-app.com/webhook",
  "subscribedEvents": [
    {
      "eventType": "person.created",
      "filter": {
        "groupId": "grp_bc984b3f-0386-434d-82d7-a91eb6badd71"
      }
    }
  ]
}

Response

The created webhook.

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": {}
      }
    ],
    "signingSecret": "whsec_QWFSUzl1QUVoQW1kdWtpTnJRTUFpbXNlZmxLTg==",
    "status": "active",
    "createdAt": "2025-07-17T09:00:00.000Z"
  },
  "deprecations": [
    "This field is deprecated"
  ]
}

Changes

  • c6818f3ba60dRevision changes
    • info

      added the new optional header request parameter Idempotency-Key

    • info

      added the new person_enrichment.finished enum value to the request property //

    • info

      added the new task.completed enum value to the request property //

    • info

      added the new task.created enum value to the request property //

    • info

      added the new task.deleted enum value to the request property //

    • info

      added the new task.updated enum value to the request property //

    • info

      added the non-success response with the status

    • 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