Skip to navigation
API Referencewebhooks

Test Webhook

Send a test webhook to verify the endpoint is working.

Sends a synthetic agent.message payload (flagged "test": true) through the real delivery path to the configured URL. The optional JSON body overrides from, to, message and channel so a handler can be exercised with the numbers it actually routes on. Pass ?agentId=… to control which agent appears in the payload; otherwise the first agent in the account is used.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Headers

X-Sub-Account-IdstringOptional

Query parameters

agentIdstring or nullOptional
Agent ID to include in the test payload

Request

This endpoint expects a nullable object.
fromstring or nullOptional
Sender number, E.164
tostring or nullOptional
Recipient number, E.164
messagestring or nullOptional<=1600 characters
Message text
channelenum or nullOptional

Channel to report in the payload (default sms)

Allowed values:

Response

Successful Response

Errors

422
Unprocessable Entity Error