Skip to main content
POST
Create a webhook subscription

Authorizations

X-Api-Key
string
header
required

API key (hr_live_... or hr_test_...). Generate from Settings › Workspace › Acceso API.

Body

application/json
url
string<uri>
required

HTTPS endpoint that will receive event payloads.

Example:

"https://yourapp.com/webhooks/hostreach"

secret
string

Secret used to sign the payload via HMAC-SHA256 (sent in X-Hostreach-Signature header). Strongly recommended.

name
string

Human-readable label for this subscription.

Example:

"Production webhook"

events
enum<string>[]

Event types to subscribe to. Defaults to all events if omitted.

Available options:
extraction.completed,
leads.imported,
lead.status_updated,
lead.first_response
Example:

Response

201 - undefined