Confirm ownership of a pending webhook by submitting the 6-character verificationCode that the server included in the activation POST during POST /v2/webhooks (or PATCH /v2/webhooks/{webhookId} when reactivation was triggered).
The code was delivered to the webhook's configured url; retrieve it from your endpoint's request log or capture buffer. On success the webhook transitions to active and the stored activationCode and last-handshake response are cleared. Returns 404 if the webhook does not exist, was soft-deleted, or belongs to another client; 400 if the webhook is already active, or if the submitted code does not match.
To prevent code-enumeration probes revealing whether a webhook is already activated, the already-active check is performed before the code comparison.
Endpoint:
HTTP Method: POST
Path: /v2/webhooks/{webhookId}/activate
Server URL: https://api.propelus.com
Developer Docs: https://propelus.com/developer/webhooks/ActivateWebhookById
The verification code was delivered to the webhook's configured url; retrieve it from your endpoint's request log or capture buffer.
On success, the webhook transitions to active -- the stored activationCode and last-handshake response are cleared. Error 404 is returned if the webhook does not exist, was soft-deleted, or belongs to another client; 400 if the webhook is already active, or if the submitted code does not match.
To prevent code-enumeration probes revealing whether a webhook is already activated, the already-active check is performed before the code comparison.
Authentication
Two header-based authentication methods are required:
| Header | Type | In | Description |
| x-api-key | token | header | API key credential |
| x-client-id | token | header | Client identifier credential |
Path Parameters
| Parameter | Type | Required | Description |
| webhookId | string (UUID) | Yes |
Unique identifier for the webhook. |
Request Body
Content type: application/json
| Field | Type | Required | Description |
| verificationCode | string | Yes |
Verification code sent to the url configured in the webhook. |
Example Request - JSON
const body = JSON.stringify({
"verificationCode": "string"
})
fetch("https://api.propelus.com/v2/webhooks/628fc8e2-ee7e-4779-9eb7-d980e7a92f3a/activate", {
method: "POST",
headers: {
"Content-Type": "application/json",
"x-api-key": "bajeWgvgvK3eU0au63bzv820Vh0r0iqta7Nj3R1O",
"x-client-id": "bajeWgvgvK3eU0au63bzv820Vh0r0iqta7Nj3R1O"
},
body
})Example Request - cURL
curl -X POST "https://api.propelus.com/v2/webhooks/628fc8e2-ee7e-4779-9eb7-d980e7a92f3a/activate" \
-H "x-api-key: bajeWgvgvK3eU0au63bzv820Vh0r0iqta7Nj3R1O" \
-H "x-client-id: bajeWgvgvK3eU0au63bzv820Vh0r0iqta7Nj3R1O" \
-H "Content-Type: application/json" \
-d '{
"verificationCode": "string"
}'Responses
200 — Success
{
"status": 200,
"code": "activated",
"detail": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}Error Responses
Standardized error bodies. Validation-style errors (400, 401, 403, 404, 4XX) include an errors array; each item contains detail, pointer, parameter, header, and code: https://propelus.com/developer/webhooks/ActivateWebhookById#response-body
400 — Bad Request
401 — Unauthorized
403 — Forbidden
404 — Not Found
4XX — Client Error
5XX — Server Error