What’s new in v2
Setting up a subscription
Navigate to Settings → Integrations → Webhooks and click Add new webhook.Subscription fields
string
required
The HTTPS endpoint that will receive webhook payloads. Must be a valid URL.
array
required
One or more event type strings to subscribe to. See Event Types for the full list.
array
Limit this subscription to events from specific campaigns. Use
[1] (the default) to receive events from all campaigns.string
Optional human-readable label for this subscription.
boolean
Enable or pause delivery without deleting the subscription. Defaults to
true.object
Custom HTTP headers to include on every request. Useful for API keys or authorization tokens your endpoint requires.
How delivery works
- An event occurs in your account (e.g., a referral is created).
- FirstPromoter checks your active subscriptions for matching event types and campaign filters.
- A delivery record is created for each matching subscription and dispatched asynchronously.
- Your endpoint receives a
POSTrequest with a JSON payload. - Respond with any
2xxstatus code to acknowledge the delivery. - If the response is not
2xx, the delivery is automatically retried.