post
https://production-api.shoutaboutus.com/api/v1/partner/webhooks
Create an outbound webhook subscription for the caller's partner. The server generates a 256-bit HMAC secret and returns the raw value ONCE in hmac_secret (never recoverable afterward except via reveal/rotate). Each partner may hold at most one non-deleted subscription per delivery_kind slot (one immediate + one batch).
Auth: Partner — authentication; requirePartnerCompanyId enforces bundle_id === 1 (403 otherwise). partner_company_id is taken from the auth user, not the body.
Rate limit: No rate limit.
Request
- Body:
| Field | Type | Required | Notes |
|---|---|---|---|
label | string | yes | max 255 |
webhook_url | string (url) | yes | url:http,https, max 2048 |
delivery_kind | string | yes | immediate | batch; unique-slot rule — fails 422 if a non-deleted sub of the same kind already exists for this partner |
batch_interval_hours | int|null | required if delivery_kind=batch | one of [1,2,4,6,12]; nullable/ignored for immediate |
events | array | no | omit or [] = all events (persisted as null). Batch subs ignore it (pinned null). On immediate slot, batch-kind events are rejected; hipages-only events rejected for non-hipages partners |
events.* | string | — | Must be one of the event names from the events catalog (GET /api/v1/partner/webhooks/events). |
payload_mode | string | no | full | minimal; defaults full; forced full on batch subs |
is_active | bool | no | defaults true |
Response — { data: { data: {.} } } envelope (HTTP 201). Same fields as the show/list presenter, PLUS the once-only secret block:
hmac_secret(string) — raw secret, shown ONCEhmac_secret_warning(string) — store-it-now warning- (no
eventsfilter persisted for batch subs →events: null;payload_modeforcedfull;last_batch_dispatched_atset to creation time for batch, null for immediate)
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…