Jump to

Webhooks

Webhooks are configured on the mailbox or phone number resource — no separate registration step.

Mailbox webhooks

Set a URL on a mailbox to receive message.received and message.sent events.

Set an incoming call webhook URL and action on a phone number.

Use verify_webhook / verifyWebhook to confirm that an incoming request was sent by Inkbox.

Runnable example scripts are available on GitHub:

Python — examples/python

Script	What it demonstrates
`register_agent_identity.py`	Create an identity, assign mailbox + phone number
`agent_send_email.py`	Send an email and a threaded reply
`read_agent_messages.py`	List messages and threads
`create_agent_mailbox.py`	Create, update, search, and delete a mailbox
`create_agent_phone_number.py`	Provision, update, and release a number
`list_agent_phone_numbers.py`	List all phone numbers in the org
`read_agent_calls.py`	List calls and print transcripts
`receive_agent_email_webhook.py`	Register and delete a mailbox webhook
`receive_agent_call_webhook.py`	Register, update, and delete a phone webhook

TypeScript — examples/typescript

Script	What it demonstrates
`register-agent-identity.ts`	Create an identity, assign mailbox + phone number
`agent-send-email.ts`	Send an email and a threaded reply
`read-agent-messages.ts`	List messages and threads
`create-agent-mailbox.ts`	Create, update, search, and delete a mailbox
`create-agent-phone-number.ts`	Provision, update, and release a number
`list-agent-phone-numbers.ts`	List all phone numbers in the org
`read-agent-calls.ts`	List calls and print transcripts
`receive-agent-email-webhook.ts`	Register and delete a mailbox webhook
`receive-agent-call-webhook.ts`	Register, update, and delete a phone webhook