Pause or reactivate a webhook subscription

POST /api/v1/webhook-subscriptions/{subscriptionId}/pause

{"paused": true} sets the subscription to paused; {"paused": false} sets it back to active. Reactivation requires a subscription that has been verified at least once, otherwise the call answers 409.

Authorization

Role in the organization	This endpoint
`OWNER`	Allowed
`ADMIN`	Allowed
`MEMBER`	Refused — `403`

Requirement	Rule for this endpoint
Business role	None beyond the organization role
Resource scope	The subscription belongs to the key's organization
Participation	None
Resource state	Reactivation requires a previous successful verification

Path parameters

Parameter	Type	Required	Description
`subscriptionId`	UUID	yes	Webhook subscription of the key's organization

Request headers

Header	Required	Description
`x-api-key`	yes	API key created for this organization
`Idempotency-Key`	yes	Stable key for this command; a replay returns the first result
`X-Correlation-Id`	no	Caller correlation id, returned or generated

Request body

Field	Type	Required	Nullable	Description
`paused`	boolean	yes	no	`true` to pause, `false` to reactivate

json

{"paused": true}

Example

bash

curl -X POST "$COHORTE_API_BASE_URL/api/v1/webhook-subscriptions/$SUBSCRIPTION_ID/pause" \
  -H "x-api-key: $COHORTE_API_KEY" \
  -H "Idempotency-Key: webhook-crm-sync-pause-001" \
  -H "Content-Type: application/json" \
  -d '{"paused":true}'

Response

200 OK — the subscription with its new status. replayed: true when the key was already used.
400 Bad Request — invalid_request: missing Idempotency-Key, invalid JSON, or paused is not a boolean.
401 Unauthorized — unauthorized: the key is missing, invalid, expired or no longer attached to a member.
403 Forbidden — forbidden: the bearer is not OWNER or ADMIN.
404 Not Found — not_found: the subscription is unknown or belongs to another organization.
409 Conflict — conflict: reactivation of a subscription that was never verified.
500 Internal Server Error — internal_error: unexpected failure.

Response fields

Field	Type	Nullable	Description
`success`	boolean	no	`true` for a successful request
`replayed`	boolean	no	`true` when the idempotency key was already used
`data.id`	UUID	no	Subscription identifier
`data.name`	string	no	Display name
`data.endpointUrl`	string	no	Destination as `scheme://host[:port]/path`; the query string is never returned
`data.eventNames`	string[]	no	Subscribed event names
`data.status`	string	no	`pending_validation`, `validating`, `active`, `paused` or `validation_failed`
`data.lastValidatedAt`	ISO 8601 string	yes	Last successful verification, in UTC
`data.lastValidationError`	string	yes	Why the last verification failed
`data.secretConfigured`	boolean	no	Always `true`; the secret itself is never returned
`data.createdAt`	ISO 8601 string	no	Creation time, in UTC
`data.updatedAt`	ISO 8601 string	no	Last change, in UTC
`correlationId`	string	no	Correlation id for support

Example response

json

{
  "success": true,
  "replayed": false,
  "data": {
    "id": "6b1e2c3d-4f50-4a61-8b72-93a4b5c6d7e8",
    "name": "CRM sync",
    "endpointUrl": "https://hooks.example.com/cohorte",
    "eventNames": ["enrollment.created", "enrollment.closed"],
    "status": "paused",
    "lastValidatedAt": "2026-09-20T09:12:04.000Z",
    "lastValidationError": null,
    "secretConfigured": true,
    "createdAt": "2026-09-20T09:10:00.000Z",
    "updatedAt": "2026-09-23T17:30:00.000Z"
  },
  "correlationId": "b7d3e1f0-2a4c-4e8b-9c1d-0f2e3a4b5c6d"
}

Notes

Events that occur while the subscription is paused are not queued for it: reactivating does not deliver them afterwards.
A retry with the same Idempotency-Key returns the first result. Pause and reactivation are recorded in the organization's audit trail.

POST /api/v1/webhook-subscriptions/{subscriptionId}/pause

Authorization

Role in the organization	This endpoint
`OWNER`	Allowed
`ADMIN`	Allowed
`MEMBER`	Refused — `403`

Requirement	Rule for this endpoint
Business role	None beyond the organization role
Resource scope	The subscription belongs to the key's organization
Participation	None
Resource state	Reactivation requires a previous successful verification

Path parameters

Parameter	Type	Required	Description
`subscriptionId`	UUID	yes	Webhook subscription of the key's organization

Request headers

Header	Required	Description
`x-api-key`	yes	API key created for this organization
`Idempotency-Key`	yes	Stable key for this command; a replay returns the first result
`X-Correlation-Id`	no	Caller correlation id, returned or generated

Request body

Field	Type	Required	Nullable	Description
`paused`	boolean	yes	no	`true` to pause, `false` to reactivate

json

{"paused": true}

Example

bash

curl -X POST "$COHORTE_API_BASE_URL/api/v1/webhook-subscriptions/$SUBSCRIPTION_ID/pause" \
  -H "x-api-key: $COHORTE_API_KEY" \
  -H "Idempotency-Key: webhook-crm-sync-pause-001" \
  -H "Content-Type: application/json" \
  -d '{"paused":true}'

Response

200 OK — the subscription with its new status. replayed: true when the key was already used.
400 Bad Request — invalid_request: missing Idempotency-Key, invalid JSON, or paused is not a boolean.
401 Unauthorized — unauthorized: the key is missing, invalid, expired or no longer attached to a member.
403 Forbidden — forbidden: the bearer is not OWNER or ADMIN.
404 Not Found — not_found: the subscription is unknown or belongs to another organization.
409 Conflict — conflict: reactivation of a subscription that was never verified.
500 Internal Server Error — internal_error: unexpected failure.

Response fields

Field	Type	Nullable	Description
`success`	boolean	no	`true` for a successful request
`replayed`	boolean	no	`true` when the idempotency key was already used
`data.id`	UUID	no	Subscription identifier
`data.name`	string	no	Display name
`data.endpointUrl`	string	no	Destination as `scheme://host[:port]/path`; the query string is never returned
`data.eventNames`	string[]	no	Subscribed event names
`data.status`	string	no	`pending_validation`, `validating`, `active`, `paused` or `validation_failed`
`data.lastValidatedAt`	ISO 8601 string	yes	Last successful verification, in UTC
`data.lastValidationError`	string	yes	Why the last verification failed
`data.secretConfigured`	boolean	no	Always `true`; the secret itself is never returned
`data.createdAt`	ISO 8601 string	no	Creation time, in UTC
`data.updatedAt`	ISO 8601 string	no	Last change, in UTC
`correlationId`	string	no	Correlation id for support

Example response

json

{
  "success": true,
  "replayed": false,
  "data": {
    "id": "6b1e2c3d-4f50-4a61-8b72-93a4b5c6d7e8",
    "name": "CRM sync",
    "endpointUrl": "https://hooks.example.com/cohorte",
    "eventNames": ["enrollment.created", "enrollment.closed"],
    "status": "paused",
    "lastValidatedAt": "2026-09-20T09:12:04.000Z",
    "lastValidationError": null,
    "secretConfigured": true,
    "createdAt": "2026-09-20T09:10:00.000Z",
    "updatedAt": "2026-09-23T17:30:00.000Z"
  },
  "correlationId": "b7d3e1f0-2a4c-4e8b-9c1d-0f2e3a4b5c6d"
}

Notes

Events that occur while the subscription is paused are not queued for it: reactivating does not deliver them afterwards.
A retry with the same Idempotency-Key returns the first result. Pause and reactivation are recorded in the organization's audit trail.

Pause or reactivate a webhook subscription

Pause or reactivate a webhook subscription

Authorization

Path parameters

Request headers

Request body

Example

Response

Response fields

Example response

Notes

Related

Authorization

Path parameters

Request headers

Request body

Example

Response

Response fields

Example response

Notes

Related