Hatif
    • Rate Limiting
    • Account API
      • Service Login
        POST
    • Channels API
      • Get Channels
        GET
    • Support API
      • Upload Image, Video, or PDF
        POST
      • Upload Audio File
        POST
    • Whatsapp API
      • Send Text
        POST
      • Send Template
        POST
      • Send Image
        POST
      • Send Audio
        POST
      • Send Video
        POST
      • Send File
        POST
      • Send Interactive Buttons
        POST
      • List Templates (Service Account)
        GET
    • Contact
      • Set Property Value on Contact
        PUT
      • Search Contacts
        POST
      • Delete Property Value on Contact
        DELETE
      • Create Contact
        POST
      • Update Contact
        PUT
      • Get Contacts
        GET
      • Get Contact By Id
        GET
      • Create Bulk Contacts vCards
        POST
      • Contacts History
        GET
    • Contact Properties
      • List Contact Properties
        GET
      • Contact Properties Statistics
        POST
      • Create Contact Property
        POST
      • Update Contact Property
        PUT
      • Delete Contact Property
        DELETE
    • Workspace API
      • Get Workspace Users
    • Conversations API
      • Get Conversation Timeline
      • List Conversations
      • Create Conversation
      • Assign Conversation
      • Get Conversation
      • Assign Conversation
    • Tags API
      • Tag a conversation
      • Create Tag
      • Delete Tag
      • Update Tag
      • List Tags
    • Outbound IVR
      • Create Outbound IVR
      • Get Outbound IVR Request
    • Outbound IVR Flows
      • Create Outbound IVR Flow
      • List Outbound IVR Flows
      • Get Outbound IVR Flow
      • Update Outbound IVR Flow
      • Delete Outbound IVR Flow
    • Tasks API
      • Create Task
      • List Tasks
      • Get Task
      • Update Task
      • Delete Task
      • List Task Properties
      • Create Task Property
      • List Task Projects
      • Create Task Project
      • Get Task Project
      • Rename Task Project
      • Delete Task Project
      • List Task Sections
      • Create Task Section
      • List Tasks By Conversation
      • Move Task
      • Schedule Task
      • Assign Task
      • Set Task Due Date
      • Complete Task
      • Reopen Task
      • Set Task Section
      • Move Task Project
      • Rename Task Section
      • Delete Task Section
      • Move Task Section
      • Update Task Property
      • Delete Task Property
      • Set Task Property Value
      • List Task Comments
      • Create Task Comment
      • Edit Task Comment
      • Delete Task Comment
      • Set Task Reminder
    • Teams API
      • Create Team
      • Get Team
      • Update Team
      • Delete Team
      • Add Team Members
      • Update Team Member Conversation Access
      • Remove Team Member
      • List Teams
      • List Team Member Options
      • List Team Assignment Targets
      • Assign Conversation to Team
    • Partner API
      • 2. Register customer
        • 1) Create registration
        • Update registration details
        • Resend mobile code
        • 2) Verify mobile code
        • 3) Send email code
        • 4) Verify email code
        • 5) Complete registration → workspace + workspace key
        • Issue another workspace key
      • 3. Subscribe (plan & balance)
        • Add wallet balance (top-up) → payment link
        • Plans you can sell (find the Builder plan ID)
        • Get wallet balance
        • Create quote (plan) → payment link
        • Get quote status (poll for payment)
      • 4. Phone number
        • Assign number (after payment)
        • Available numbers
        • List the workspace's channels
      • 5. Contract
        • Replaced: use Get activation link
        • Replaced: number status is on the channel
        • Get activation link
      • 6. AI agent (SIP)
        • Connect the number to your AI agent
        • Disconnect your AI agent
      • 7. Calls & events
        • Not available yet: list calls
        • Not available yet: set events webhook
    • Call Webhook
    • WhatsApp Message Webhook
    • Schemas
      • Call Webhook
      • WhatsApp Message Webhook
      • ServiceAccountTemplateDto
      • OutboundIvrOption
      • ConversationDto
      • RegistrationDetails
      • CreateTagDto
      • AbpError
      • ServiceAccountTemplateParameterDto
      • OutboundIvrQuestionStepProps
      • ChannelConversationDto
      • UpdateTagDto
      • TaskPropertyValue
      • CreateRegistration
      • ServiceAccountCreateTaskDto
      • TemplateParameterDto
      • OutboundIvrStep
      • OtpCode
      • TagDto
      • PagedResultOfTagDto
      • TaskActivityPropertySnapshot
      • ConversationTimelineDto
      • ApiCredential
      • ParameterValueDto
      • CreateOutboundIvrRequest
      • TaskActivitySnapshot
      • SaveOutboundIvrFlow
      • ChannelNotFoundError
      • OutboundIvrFlow
      • Quote
      • AiSummaryDto
      • TaskActivityDto
      • ReplyInfoDto
      • OutboundIvrAnswer
      • TaskSummaryDto
      • InternalThreadDto
      • OutboundIvrStatus
      • TaskDto
      • LocationMessageDto
      • OutboundIvrResult
      • PagedResultOfTaskDto
      • AssignationInfoDto
      • TaskPropertyDefinitionDto
      • PagedResultOfConversationDto
      • OutboundIvrAudioType
      • OutboundIvrRequest
      • PagedResultOfConversationTimelineDto
      • TaskProjectDto
      • TaskSectionDto
      • OutboundIvrWebhookPayload
      • PagedResultOfTaskProjectDto
      • PagedResultOfTaskSectionDto
      • UpdateTaskDto
      • MoveTaskDto
      • SetTaskSectionDto
      • SetTaskScheduleDto
      • AssignTaskDto
      • SetTaskDueDateDto
      • NameDto
      • MoveBeforeDto
      • TaskPropertyOptionDto
      • CreateTaskPropertyDto
      • UpdateTaskPropertyDto
      • TaskCommentDto
      • WriteTaskCommentDto
      • PagedResultOfTaskCommentDto
      • SetTaskReminderDto

      WhatsApp Message Webhook

      Webhook
      POST
      WhatsApp Message Webhook

      Configuration#

      Go to Settings → API Connect to configure your WhatsApp Webhook URL and optionally generate a Webhook Signing Secret for request verification.

      Authentication#

      If a webhookSecret is configured on the channel, all webhook requests include an X-Voxa-Signature header containing an HMAC-SHA256 signature of the raw JSON request body.

      Verifying the Signature#

      1.
      Get the raw request body as a UTF-8 string.
      2.
      Compute the HMAC-SHA256 hash using your channel's webhookSecret as the key.
      3.
      Convert the hash to a lowercase hexadecimal string.
      4.
      Compare the computed signature with the X-Voxa-Signature header value.

      Retry Policy#

      Failed deliveries are retried up to 5 times with exponential backoff: 2, 4, 8, 16, 32 minutes.

      Request

      Authorization
      JWT Bearer
      Add the parameter
      Authorization
      to Headers
      Example:
      Authorization: ********************
      or
      Body Params application/jsonRequired

      Examples

      Responses

      🟢200Success
      application/json
      Bodyapplication/json

      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location 'https://your-api-server.com' \
      --header 'Authorization: Bearer <token>' \
      --header 'Content-Type: application/json' \
      --data '{
          "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",
          "channelId": "5f6d08bc-455a-4532-98b8-19e2cee51160",
          "conversationId": "ee6e55e8-45fe-4a3e-9bc8-4669f9fdf77a",
          "conversationEventId": "84485902-55d7-4844-953e-8ae607e3d2c5",
          "contactId": "b5ec5d98-4bee-4da1-ad24-dde86346cb1d",
          "messageId": "string",
          "direction": "Inbound",
          "messageType": "Text",
          "body": "string",
          "mediaUrl": "string",
          "mimeType": "string",
          "status": "Sent",
          "senderUserId": "2b0414b9-b88f-4722-84b0-333eb47e9180",
          "latitude": 0,
          "longitude": 0,
          "contacts": [
              {
                  "firstName": "string",
                  "lastName": "string",
                  "middleName": "string",
                  "formattedName": "string",
                  "company": "string",
                  "phones": [
                      {
                          "phone": "string",
                          "type": "string",
                          "waId": "string"
                      }
                  ]
              }
          ],
          "creationTime": "2019-08-24T14:15:22.123Z",
          "isBillable": true,
          "errorCode": 0,
          "errorReason": "string",
          "transcription": {
              "text": "string",
              "words": [
                  {
                      "text": "string",
                      "start": 0,
                      "end": 0,
                      "type": "string",
                      "speaker": "string"
                  }
              ]
          },
          "summary": "string",
          "sentiment": 1,
          "replyToMessageId": "string",
          "interactiveReply": {
              "id": "string",
              "text": "string",
              "payload": "string",
              "templateId": "string",
              "templateName": "string"
          },
          "sentTemplate": {
              "templateId": "string",
              "templateName": "string",
              "language": "string",
              "category": "Marketing",
              "buttons": [
                  {
                      "type": "QuickReply",
                      "text": "string",
                      "url": "string",
                      "phoneNumber": "string",
                      "copyCode": "string"
                  }
              ]
          }
      }'
      Response Response Example
      {}
      Modified at 2026-08-04 23:39:45
      Previous
      Call Webhook
      Next
      Call Webhook
      Built with