Register an Event

Registering to an Event

Register for entire event categories or specific events. For example, register for "receiver" to catch all receiver events, or "receiver.subscribed" for subscriptions only.

Registration includes a verification process to ensure endpoint validity.

Registration Request

Send a POST to https://rest.cleverreach.com/hooks/eventhook with this JSON payload:

{
  "url": "https://hook.waynecorp.gc/cleverreach",
  "event": "receiver",
  "condition": "1939",
  "verify": "damnSecretBatTokenForVerify"
}

Field	Description
url	HTTPS endpoint for webhook POSTs and verification GETs.
event	Event or category to register (e.g., "receiver" or "receiver.subscribed").
condition	Optional filter (e.g., group ID for receiver events).
verify	Verification token (10-50 characters).

Verification Process

Your endpoint handles both verification (GET) and webhook events (POST).

Verification (GET)

CleverReach sends a GET request with a secret parameter. Respond with your verify token + space + secret value.

Response Example

For verify token "damnSecretBatTokenForVerify" and secret=1029384756:

damnSecretBatTokenForVerify 1029384756

Registration Response

Successful registration returns:

{
  "success": true,
  "call_token": "a#64characters-longtoken_deliveredoneverycall_toverifycallorigin",
  "secret": "this_isOnly32charsUsedfordecrypt"
}

• success: Boolean indicating success.
• call_token: Verify webhook origin via x-cr-calltoken header.
• secret: Decrypt encrypted payload data.

Webhook Events (POST)

Webhooks arrive as POST requests with event data. See Data Examples for details.

Handling Webhooks

• Verify x-cr-calltoken header matches registration call_token.
• Process payload and respond quickly to avoid timeouts.

Delete a Registration

Unregister webhooks via DELETE.

• Delete all for an event: DELETE /hooks/eventhook/{eventname}
• Delete with condition: DELETE /hooks/eventhook/{eventname}/{condition}

Returns 200 on success or 404 if not found.

List Registrations

Retrieve registered webhooks: GET /hooks/eventhook