Create a webhook subscription

POST /api/v2/webhook-subscriptions

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

application/json

Body Required

url string Required

The URL of the webhook you would like Plannr to send events to.
events array[string] Required

The events the webhook subscription is subscribed to. The available events are: account.created, account.updated, account.deleted, account.annual-review-date-occurred, circle.created, circle.updated, circle.deleted, plan.created, plan.updated, plan.deleted, case.created, case.updated, case.deleted, task.created, task.updated, task.deleted, task.completed, fact-find.completed and form-submission.completed

Responses

201 application/json
Hide response attributes Show response attributes object
- uuid string
  
  The UUID of the resource.
- created_at string
  
  The timestamp of when the resource was created.
- updated_at string
  
  The timestamp of when the resource was updated.
- signing_secret string
  
  The signing secret of the webhook. You can use this to create your own signature of the webhook body and compare it against the X-Signature header Plannr sends. This ensures that the payload has not been modified.
- url string
  
  The URL of the webhook Plannr will send events to.
- events array[string]
  
  The events the webhook subscription is subscribed to.
- last_outgoing_webhook_call_at string
  
  The last time Plannr sent a request to this webhook.

POST /api/v2/webhook-subscriptions

curl \
 --request POST 'https://api.plannrcrm.com/api/v2/webhook-subscriptions' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"url":"https://api.example.com/webhooks","events":["account.deleted","circle.created"]}'

Request examples

# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "url": "https://api.example.com/webhooks",
  "events": [
    "account.deleted",
    "circle.created"
  ]
}

Response examples (201)

{
  "url": "https://api.example.com/webhooks",
  "uuid": "cacb670a-823d-4089-b09f-c3542d5a7d4b",
  "events": [
    "account.deleted",
    "circle.created"
  ],
  "created_at": "2025-07-03T15:26:37+01:00",
  "updated_at": "2025-07-03T15:26:37+01:00",
  "signing_secret": "QEICkB3SJxHouRakb8v3p7CMm1sfB3AvTGuod1bg7R7TMUYd5DPvJC679ZRE",
  "last_outgoing_webhook_call_at": "2025-07-03T15:26:37+01:00"
}