POST HandleWebhook

Request Information

URI Parameters

None.

Body Parameters

UserMessage
NameDescriptionTypeAdditional information
lastName

string

None.

chatPlatform

string

None.

customerCreationTime

date

None.

contactId

string

None.

sessionId

string

None.

type

string

None.

whatsappNumber

string

None.

firstName

string

None.

sessionCreationTime

date

None.

v

string

None.

customerId

string

None.

messages

Collection of Messages

None.

chatChannelId

string

None.

Request Formats

application/json, text/json

Sample:
{
  "lastName": "sample string 1",
  "chatPlatform": "sample string 2",
  "customerCreationTime": "2025-10-25T14:21:02.0484756-03:00",
  "contactId": "sample string 4",
  "sessionId": "sample string 5",
  "type": "sample string 6",
  "whatsappNumber": "sample string 7",
  "firstName": "sample string 8",
  "sessionCreationTime": "2025-10-25T14:21:02.0484756-03:00",
  "v": "sample string 10",
  "customerId": "sample string 11",
  "messages": [
    {
      "date": "2025-10-25T14:21:02.0640971-03:00",
      "fromName": "sample string 2",
      "_id_": "sample string 3",
      "from": "sample string 4",
      "clientPayload": "sample string 5",
      "message": "sample string 6",
      "operatorId": "sample string 7",
      "fromCustomer": true
    },
    {
      "date": "2025-10-25T14:21:02.0640971-03:00",
      "fromName": "sample string 2",
      "_id_": "sample string 3",
      "from": "sample string 4",
      "clientPayload": "sample string 5",
      "message": "sample string 6",
      "operatorId": "sample string 7",
      "fromCustomer": true
    }
  ],
  "chatChannelId": "sample string 12"
}

application/xml, text/xml

Sample:
<UserMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BotmakerAPI.Models.Customer">
  <ChatChannelId>sample string 12</ChatChannelId>
  <ChatPlatform>sample string 2</ChatPlatform>
  <ContactId>sample string 4</ContactId>
  <CustomerCreationTime>2025-10-25T14:21:02.0484756-03:00</CustomerCreationTime>
  <CustomerId>sample string 11</CustomerId>
  <FirstName>sample string 8</FirstName>
  <LastName>sample string 1</LastName>
  <Messages>
    <Messages>
      <ClientPayload>sample string 5</ClientPayload>
      <Date>2025-10-25T14:21:02.0640971-03:00</Date>
      <From>sample string 4</From>
      <FromCustomer>true</FromCustomer>
      <FromName>sample string 2</FromName>
      <Message>sample string 6</Message>
      <MessageId>sample string 3</MessageId>
      <OperatorId>sample string 7</OperatorId>
    </Messages>
    <Messages>
      <ClientPayload>sample string 5</ClientPayload>
      <Date>2025-10-25T14:21:02.0640971-03:00</Date>
      <From>sample string 4</From>
      <FromCustomer>true</FromCustomer>
      <FromName>sample string 2</FromName>
      <Message>sample string 6</Message>
      <MessageId>sample string 3</MessageId>
      <OperatorId>sample string 7</OperatorId>
    </Messages>
  </Messages>
  <SessionCreationTime>2025-10-25T14:21:02.0484756-03:00</SessionCreationTime>
  <SessionId>sample string 5</SessionId>
  <Type>sample string 6</Type>
  <V>sample string 10</V>
  <WhatsappNumber>sample string 7</WhatsappNumber>
</UserMessage>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.