Skip to main content
POST
Dispatch a Signed Test Delivery Receipt Webhook

Authorizations

Client-ID
string
header
required

Your UgaText Client-ID (e.g. uga_...). Accepted header aliases: X-Client-ID, or combined in Authorization: Bearer : / X-API-Key: :.

Client-Secret
string
header
required

Your UgaText Client-Secret (e.g. sk_live_...). Accepted header alias: X-Client-Secret.

Body

application/json
url
string<uri>

HTTPS webhook endpoint URL to test. If omitted, dispatches to the active webhook URLs registered on your account.

Example:

"https://api.yourdomain.com/sms/dlr"

secret
string

Optional HMAC-SHA256 signing secret override.

Example:

"whsec_live_example_secret"

event
enum<string>
default:sms.delivered
Available options:
sms.delivered,
sms.sent,
sms.failed
recipient
string
Example:

"+256750625684"

Response

Test webhook delivery attempted (payload matches real delivery payload field-for-field)

success
boolean
Example:

true

dispatched_count
integer
Example:

1

status_code
integer
Example:

200

signature
string
payload
object
request_payload
object