API Reference
  1. Beep Platform API
  2. Notification Settings

Update notification settings

put
https://app.beepmessaging.com/api/v1/notification-settings

Upserts the workspace default reply destination and status callback configuration. Provide status_callback_secret to set/rotate the signing secret, or generate_status_callback_secret=true to have Beep generate one and return it once as generated_secret. Requires a manager or admin API key.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
uuid | null

Reply destination that catches inbound messages with no thread-level destination — including first-contact texts to your number.

uuid | null

Workspace-default status callback destination (from GET/POST /api/v1/status-callback-destinations) used to report message lifecycle when no per-number or per-send override applies. Send null to clear.

uri | null

Workspace URL that receives delivery-status callbacks for every send. Callbacks are signed with status_callback_secret. This is the recommended, verifiable path (unlike the per-send status_callback override on POST /api/v1/messages).

string | null

Secret used to HMAC-sign status callbacks (X-Beep-Signature). Stored encrypted and never returned. Send a new value to rotate. Mutually exclusive with generate_status_callback_secret.

boolean

When true, Beep generates a strong signing secret and returns it once as generated_secret in the response. Use this instead of status_callback_secret to let Beep create the secret. Mutually exclusive with status_callback_secret.

Headers
uuid
required
Responses

Updated 4 months ago

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

Updated 4 months ago

Did this page help you?