POST api/webhook/whatsapp
Request Information
URI Parameters
None.
Body Parameters
WebhookPayload| Name | Description | Type | Additional information |
|---|---|---|---|
| object | string |
None. |
|
| entry | Collection of Entry |
None. |
Request Formats
application/json, text/json
Sample:
{
"object": "sample string 1",
"entry": [
{
"id": "sample string 1",
"changes": [
{
"value": {
"messaging_product": "sample string 1",
"metadata": {
"display_phone_number": "sample string 1",
"phone_number_id": "sample string 2"
},
"statuses": [
{
"id": "sample string 1",
"status": "sample string 2",
"timestamp": "sample string 3",
"recipient_id": "sample string 4",
"errors": [
{
"code": 1,
"title": "sample string 2"
},
{
"code": 1,
"title": "sample string 2"
}
]
},
{
"id": "sample string 1",
"status": "sample string 2",
"timestamp": "sample string 3",
"recipient_id": "sample string 4",
"errors": [
{
"code": 1,
"title": "sample string 2"
},
{
"code": 1,
"title": "sample string 2"
}
]
}
]
},
"field": "sample string 1"
},
{
"value": {
"messaging_product": "sample string 1",
"metadata": {
"display_phone_number": "sample string 1",
"phone_number_id": "sample string 2"
},
"statuses": [
{
"id": "sample string 1",
"status": "sample string 2",
"timestamp": "sample string 3",
"recipient_id": "sample string 4",
"errors": [
{
"code": 1,
"title": "sample string 2"
},
{
"code": 1,
"title": "sample string 2"
}
]
},
{
"id": "sample string 1",
"status": "sample string 2",
"timestamp": "sample string 3",
"recipient_id": "sample string 4",
"errors": [
{
"code": 1,
"title": "sample string 2"
},
{
"code": 1,
"title": "sample string 2"
}
]
}
]
},
"field": "sample string 1"
}
]
},
{
"id": "sample string 1",
"changes": [
{
"value": {
"messaging_product": "sample string 1",
"metadata": {
"display_phone_number": "sample string 1",
"phone_number_id": "sample string 2"
},
"statuses": [
{
"id": "sample string 1",
"status": "sample string 2",
"timestamp": "sample string 3",
"recipient_id": "sample string 4",
"errors": [
{
"code": 1,
"title": "sample string 2"
},
{
"code": 1,
"title": "sample string 2"
}
]
},
{
"id": "sample string 1",
"status": "sample string 2",
"timestamp": "sample string 3",
"recipient_id": "sample string 4",
"errors": [
{
"code": 1,
"title": "sample string 2"
},
{
"code": 1,
"title": "sample string 2"
}
]
}
]
},
"field": "sample string 1"
},
{
"value": {
"messaging_product": "sample string 1",
"metadata": {
"display_phone_number": "sample string 1",
"phone_number_id": "sample string 2"
},
"statuses": [
{
"id": "sample string 1",
"status": "sample string 2",
"timestamp": "sample string 3",
"recipient_id": "sample string 4",
"errors": [
{
"code": 1,
"title": "sample string 2"
},
{
"code": 1,
"title": "sample string 2"
}
]
},
{
"id": "sample string 1",
"status": "sample string 2",
"timestamp": "sample string 3",
"recipient_id": "sample string 4",
"errors": [
{
"code": 1,
"title": "sample string 2"
},
{
"code": 1,
"title": "sample string 2"
}
]
}
]
},
"field": "sample string 1"
}
]
}
]
}
application/xml, text/xml
Sample:
<WebhookPayload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NEOWAY.Model.WhatsAppNotification">
<Entry>
<Entry>
<Changes>
<Change>
<Field>sample string 1</Field>
<Value>
<MessagingProduct>sample string 1</MessagingProduct>
<Metadata>
<DisplayPhoneNumber>sample string 1</DisplayPhoneNumber>
<PhoneNumberId>sample string 2</PhoneNumberId>
</Metadata>
<Statuses>
<StatusUpdate>
<Errors>
<WhatsAppError>
<Code>1</Code>
<Title>sample string 2</Title>
</WhatsAppError>
<WhatsAppError>
<Code>1</Code>
<Title>sample string 2</Title>
</WhatsAppError>
</Errors>
<Id>sample string 1</Id>
<RecipientId>sample string 4</RecipientId>
<Status>sample string 2</Status>
<Timestamp>sample string 3</Timestamp>
</StatusUpdate>
<StatusUpdate>
<Errors>
<WhatsAppError>
<Code>1</Code>
<Title>sample string 2</Title>
</WhatsAppError>
<WhatsAppError>
<Code>1</Code>
<Title>sample string 2</Title>
</WhatsAppError>
</Errors>
<Id>sample string 1</Id>
<RecipientId>sample string 4</RecipientId>
<Status>sample string 2</Status>
<Timestamp>sample string 3</Timestamp>
</StatusUpdate>
</Statuses>
</Value>
</Change>
<Change>
<Field>sample string 1</Field>
<Value>
<MessagingProduct>sample string 1</MessagingProduct>
<Metadata>
<DisplayPhoneNumber>sample string 1</DisplayPhoneNumber>
<PhoneNumberId>sample string 2</PhoneNumberId>
</Metadata>
<Statuses>
<StatusUpdate>
<Errors>
<WhatsAppError>
<Code>1</Code>
<Title>sample string 2</Title>
</WhatsAppError>
<WhatsAppError>
<Code>1</Code>
<Title>sample string 2</Title>
</WhatsAppError>
</Errors>
<Id>sample string 1</Id>
<RecipientId>sample string 4</RecipientId>
<Status>sample string 2</Status>
<Timestamp>sample string 3</Timestamp>
</StatusUpdate>
<StatusUpdate>
<Errors>
<WhatsAppError>
<Code>1</Code>
<Title>sample string 2</Title>
</WhatsAppError>
<WhatsAppError>
<Code>1</Code>
<Title>sample string 2</Title>
</WhatsAppError>
</Errors>
<Id>sample string 1</Id>
<RecipientId>sample string 4</RecipientId>
<Status>sample string 2</Status>
<Timestamp>sample string 3</Timestamp>
</StatusUpdate>
</Statuses>
</Value>
</Change>
</Changes>
<Id>sample string 1</Id>
</Entry>
<Entry>
<Changes>
<Change>
<Field>sample string 1</Field>
<Value>
<MessagingProduct>sample string 1</MessagingProduct>
<Metadata>
<DisplayPhoneNumber>sample string 1</DisplayPhoneNumber>
<PhoneNumberId>sample string 2</PhoneNumberId>
</Metadata>
<Statuses>
<StatusUpdate>
<Errors>
<WhatsAppError>
<Code>1</Code>
<Title>sample string 2</Title>
</WhatsAppError>
<WhatsAppError>
<Code>1</Code>
<Title>sample string 2</Title>
</WhatsAppError>
</Errors>
<Id>sample string 1</Id>
<RecipientId>sample string 4</RecipientId>
<Status>sample string 2</Status>
<Timestamp>sample string 3</Timestamp>
</StatusUpdate>
<StatusUpdate>
<Errors>
<WhatsAppError>
<Code>1</Code>
<Title>sample string 2</Title>
</WhatsAppError>
<WhatsAppError>
<Code>1</Code>
<Title>sample string 2</Title>
</WhatsAppError>
</Errors>
<Id>sample string 1</Id>
<RecipientId>sample string 4</RecipientId>
<Status>sample string 2</Status>
<Timestamp>sample string 3</Timestamp>
</StatusUpdate>
</Statuses>
</Value>
</Change>
<Change>
<Field>sample string 1</Field>
<Value>
<MessagingProduct>sample string 1</MessagingProduct>
<Metadata>
<DisplayPhoneNumber>sample string 1</DisplayPhoneNumber>
<PhoneNumberId>sample string 2</PhoneNumberId>
</Metadata>
<Statuses>
<StatusUpdate>
<Errors>
<WhatsAppError>
<Code>1</Code>
<Title>sample string 2</Title>
</WhatsAppError>
<WhatsAppError>
<Code>1</Code>
<Title>sample string 2</Title>
</WhatsAppError>
</Errors>
<Id>sample string 1</Id>
<RecipientId>sample string 4</RecipientId>
<Status>sample string 2</Status>
<Timestamp>sample string 3</Timestamp>
</StatusUpdate>
<StatusUpdate>
<Errors>
<WhatsAppError>
<Code>1</Code>
<Title>sample string 2</Title>
</WhatsAppError>
<WhatsAppError>
<Code>1</Code>
<Title>sample string 2</Title>
</WhatsAppError>
</Errors>
<Id>sample string 1</Id>
<RecipientId>sample string 4</RecipientId>
<Status>sample string 2</Status>
<Timestamp>sample string 3</Timestamp>
</StatusUpdate>
</Statuses>
</Value>
</Change>
</Changes>
<Id>sample string 1</Id>
</Entry>
</Entry>
<Object>sample string 1</Object>
</WebhookPayload>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
HttpResponseMessage| Name | Description | Type | Additional information |
|---|---|---|---|
| Version | Version |
None. |
|
| Content | HttpContent |
None. |
|
| StatusCode | HttpStatusCode |
None. |
|
| ReasonPhrase | string |
None. |
|
| Headers | Collection of Object |
None. |
|
| RequestMessage | HttpRequestMessage |
None. |
|
| IsSuccessStatusCode | boolean |
None. |