API Reference

Update a webhook

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

Change a subscription's URL, label, event filter, or settings. Send only what changes. Use this when you move your endpoint or want different events. The signing secret is unchanged; to replace it, use Rotate the signing secret.

Prerequisites: a Partner bearer token and the subscription's id (from List your webhooks).

Authentication: Partner token. Only partner users can call it; other tokens get 403. Only your own partner's subscriptions: any other id gets 404.

Rate limit: none.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Defaults to 3

Required. The subscription's id, from List your webhooks.

Body Params
string
length ≤ 255
Defaults to Updated webhook label

Your name for the subscription. Up to 255 characters; can't be empty when sent.

uri
length ≤ 2048
Defaults to https://partner.example.com/hooks/sau-v2

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

boolean
Defaults to true

false pauses deliveries; true turns them back on.

string
enum

immediate or batch. You can have one of each, so switching to the kind you already have elsewhere gets 422.

Allowed:
integer
enum

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

Allowed:
events
array of strings

Replaces the event filter (immediate only), by value from the events catalogue; only immediate events can be picked. [] or null: all immediate events. Ignored on a batch subscription (stored as null).

events
string
enum
Defaults to minimal

Immediate only: full or minimal. A batch subscription is always full.

Allowed:
Responses

Updated 17 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 17 days ago

Did this page help you?