Create sender
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Create a sender. Provide phoneNumber for an SMS/WhatsApp sender, emailAddress (with a verified email domain) for an email sender, or enableSmsOneway: true for a zero-setup one-way SMS sender — at least one is required.
Phone number in E.164 format, and it must be a number your project already owns (see GET /v1/phone-numbers). The number is routed to the sender as part of this call, which is what turns the SMS channel on. Passing a number the project does not own, or one already attached to another sender, returns 400 rather than creating a sender that cannot send. Omit for an email-only sender.
Let this sender place and answer phone calls. Requires phoneNumber; enabling it without one returns 400. Check the channels array on the response to confirm voice is on.
Enable the one-way SMS channel (sms_oneway). Needs nothing else — no phone number, no credential — so it is the fastest way to get a sender that can send. Recipients cannot reply. Confirm with sms_oneway in the channels array on the response.
HTTPS URL for webhook events.
Events to subscribe to.
Type of event that triggers the webhook.
Message lifecycle events:
message.queued: Message created and queued for sending.data.status=queuedmessage.sent: Message accepted by the provider.data.status=sentmessage.delivered: Message delivered to recipient.data.status=deliveredmessage.read: Message was read by the recipient (WhatsApp only).data.status=readmessage.failed: Message failed to send.data.status=failed
Inbound events:
message.inbound: New message received from a contact.data.conversationIdis the inbox thread id (deep-link withhttps://dashboard.zavu.dev/{locale}/inbox?conv={conversationId}); it isnullwhile the conversation row is still being created (the first message of a brand-new thread, or several near-simultaneous first messages), whereconversation.newcarries the id instead —GET /v1/messages/{messageId}always has it. Reactions are delivered asmessage.inboundwithmessageType='reaction'. When the contact replied to (quoted) an earlier message,data.contentcarries the reply context:replyToMessageId,replyToProviderMessageId,replyToFrom,replyToText, andreplyToMessageType.data.providerTimestampis the provider's original receive time in Unix milliseconds (the moment the channel received the message from the contact — WhatsApp, Telegram, Instagram, Messenger;nullfor SMS and email). Compare it against the top-leveltimestamp(when Zavu dispatched the webhook) to detect and ignore delayed deliveries.message.unsupported: Received a message type that is not supported
Broadcast events:
broadcast.status_changed: Broadcast status changed (pending_review, approved, rejected, sending, completed, cancelled)
Other events:
conversation.new: New conversation started with a contact.datacarriesconversationId(the inbox thread id — deep-link withhttps://dashboard.zavu.dev/{locale}/inbox?conv={conversationId}), thephoneNumberoremailkey,channel,firstMessageId,firstMessageText, andprofileName.template.status_changed: WhatsApp template approval status changed
Partner events:
invitation.status_changed: A partner invitation status changed (pending, in_progress, completed, cancelled, failed).datacarriesinvitationId,clientName,clientEmail,connectionType(whatsapp_wabaormessenger),previousStatus, andcurrentStatus. Oncompletedit also carriessenderIdandconnectedAccount(channel,id,name) — the WhatsApp number or Facebook Page that was linked. Onfailedit carriesfailureReason; the invitation link stays usable, so a client can retry it.
Voice Agent events:
For every voice event, data carries callId, direction, from, to, status, durationSeconds, endReason, and transcriptAvailable. The terminal events (call.completed, call.failed) additionally carry cost — what the call was billed, in USD, combining telephony and the managed voice pipeline — and currency. They are dispatched after the call is charged, so cost is populated rather than zero; telephony can still be settling on an outbound call, in which case GET /v1/calls/{callId} holds the reconciled figure.
call.initiated: An outbound call was created and is dialing, or an inbound call was received.data.status=ringingcall.answered: The call was answered and the voice agent is connected.data.status=in_progresscall.completed: The call ended after a conversation.data.status=completed;durationSecondsandendReasondescribe how it ended, andtranscriptAvailableindicates whether a transcript can be fetched.call.failed: The call could not be completed (busy, no answer, canceled, or an error).data.statusis the terminal status andendReasonexplains the cause.
Custom domain events:
domain.verified: A custom email domain passed verification (DKIM, and SPF/DMARC/MAIL FROM if enhanced records are enabled)domain.failed: A custom email domain failed verification or is partially verified
message.queued, message.sent, message.delivered, message.read, message.status, message.failed, message.inbound, message.unsupported, broadcast.status_changed, conversation.new, template.status_changed, invitation.status_changed, call.initiated, call.answered, call.completed, call.failed, domain.verified, domain.failed From-address for the email channel (e.g. noreply@yourdomain.com). The address's domain must be a verified email domain in your project. Setting this attaches the email channel to the sender.
"noreply@yourdomain.com"
ID of the verified email domain to attach. Optional — resolved from emailAddress's domain when omitted.
Display name shown in the recipient's inbox for the email channel.
100Enable inbound email receiving on this sender. Requires a verified MX record on the domain; ignored otherwise.
Signature scheme for this sender's webhook. Defaults to v2, which is correct for a new receiver. Pass v1+v2 when this sender points at an endpoint that already serves an older sender still verifying v1.
v1, v1+v2, v2 "v2"
Response
Sender created.
"sender_12345"
"Primary sender"
Phone number in E.164 format.
"+13125551212"
Channels this sender can actually send on right now, computed from its configuration. Empty means the sender cannot send or receive anything yet: a phoneNumber alone does not enable SMS or voice. Check this rather than inferring capability from phoneNumber or emailAddress.
Whether this sender is the project's default.
Webhook configuration for the sender.
WhatsApp Business Account information. Only present if a WABA is connected.
From-address for the email channel, if configured.
"noreply@yourdomain.com"
Whether inbound email receiving is enabled for this sender.
Whether catch-all receiving is enabled. When true (and emailReceivingEnabled is true), this sender receives email addressed to any local part at its domain, not just its own address. The original recipient is delivered in the message.inbound webhook's data.to.
