Create a webhook

post

https://production-api.shoutaboutus.com/api/v1/partner/webhooks

Register a URL to receive events, choose immediate or batch delivery, and optionally filter which events you want. A partner can have one immediate and one batch subscription. You'll get the signing secret (hmac_secret) in this response and nowhere else automatically; store it now. Send a label, your HTTPS URL, and the delivery type (plus batch_interval_hours for batch). Returns the subscription and its secret; deliveries start with the next matching event.

Prerequisites: a Partner bearer token and your endpoint's HTTPS URL. Optional: the events you want, from List the events you can subscribe to.

Authentication: Partner token. Only partner users can call it; other tokens get 403. The subscription is created for the partner behind the token.

Rate limit: none.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

label

string

required

length ≤ 255

Defaults to Production webhook

Your name for the subscription. Up to 255 characters.

webhook_url

uri

required

length ≤ 2048

Defaults to https://partner.example.com/hooks/sau

Your endpoint's HTTPS URL. Up to 2048 characters.

delivery_kind

string

enum

required

Defaults to immediate

immediate (each event as it happens) or batch (one cache_invalidation ping per location per interval). You can have one of each; a second of the same kind gets 422.

Allowed:

batch_interval_hours

integer

enum

Hours between batches: 1, 2, 4, 6 or 12. Required when delivery_kind is batch.

Allowed:

events

array of strings

Defaults to review_pull_connected,review_pull_disconnected,usage.limit_reached

Immediate only: the events to receive, by value from the events catalogue. Only immediate events can be picked. Left out, [] or null: all immediate events. Ignored on a batch subscription (stored as null).

events

payload_mode

string

enum

Defaults to full

Immediate only: full (default; the review, who did it, and the history entry) or minimal (event name and ids only). A batch subscription is always full.

Allowed:

is_active

boolean

Defaults to true

Whether deliveries start now. Default true.

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The subscription was created; store hmac_secret now.

401The token is missing, expired or invalid.

403The token isn't a Partner token.

422A field is missing or invalid, an event isn't in the catalogue or can't be picked, or you already have a subscription of this kind.

500Unexpected server error.