Skip to main content
POST
/
webhook
cURL
curl --request POST \
  --url https://api.hookpulse.io/webhook \
  --header 'Content-Type: application/json' \
  --header 'x-brand-uuid: <api-key>' \
  --header 'x-hookpulse-api-key: <api-key>' \
  --data '
{
  "data": {},
  "timestamp": "2023-11-07T05:31:56Z"
}
'
{
  "event": "resource.created",
  "data": {
    "id": "res_1234567890",
    "name": "My New Resource",
    "type": "webhook",
    "created_at": "2024-01-01T00:00:00Z"
  },
  "timestamp": "2024-01-01T00:00:00Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.hookpulse.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

Hookpulse sends webhook events to your configured endpoint when resources are created, updated, or deleted.

​
Setup

  1. Navigate to your webhook settings in the dashboard
  2. Click “Add Webhook”
  3. Enter your webhook URL
  4. Select the events you want to receive
  5. Save your webhook configuration

​
Webhook signature

All webhook requests include a signature header for verification: 
X-Hookpulse-Signature: sha256=...
Verify the signature using your webhook secret to ensure the request is from Hookpulse.

​
Event types

EventDescription
resource.createdTriggered when a new resource is created
resource.updatedTriggered when a resource is updated
resource.deletedTriggered when a resource is deleted

​
Example payload

{
  "event": "resource.created",
  "data": {
    "id": "res_1234567890",
    "name": "My New Resource",
    "type": "webhook",
    "created_at": "2024-01-01T00:00:00Z"
  },
  "timestamp": "2024-01-01T00:00:00Z"
}

​
Response

Your webhook endpoint should return a 200 OK status code to acknowledge receipt of the event. Hookpulse will retry failed webhook deliveries up to 3 times with exponential backoff.

Authorizations

​
x-hookpulse-api-key
string
header
required

API key for authentication. Get this from your dashboard by selecting a brand and going to API Keys section.

​
x-brand-uuid
string
header
required

Brand UUID for authentication. Get this from your dashboard after adding a brand - it will be displayed in the UI.

Body

application/json

Webhook event payload

​
event
enum<string>
required

Type of event

Available options:
resource.created,
resource.updated,
resource.deleted
​
data
object
required

Event data payload

​
timestamp
string<date-time>

ISO 8601 timestamp of when the event occurred

Response

200

Webhook received successfully