# Event Webhook Variables Event Webhook Variables keep changing based on the type of event , below are currently available events | Event | Details | Event ID | | ----------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | -------- | | [Delivery Report](/api-documentation-v2/event-webhook/event-webhook-variables.md#delivery-report-event-i-e-event_id-1) | Delivery Report Event | 1 | | [WhatsApp Filter](/api-documentation-v2/event-webhook/event-webhook-variables.md#whatsapp-filter-report-event-i-e-event_id-2) | WhatsApp Filter Event | 2 | | [WhatsApp Group ](/api-documentation-v2/event-webhook/event-webhook-variables.md#whatsapp-group-events-i-e-event_id-3) | WhatsApp Group Member Join & Exit Event | 3 | | [New Subscriber Alert](/api-documentation-v2/event-webhook/event-webhook-variables.md#new-subscriber-alert-i-e-event_id-4) | Alerts when new subscribers | 4 | ## Delivery Report Event i.e event\_id = 1 This event helps you to get the delivery reports pushed directly to your application when its available with us {% hint style="danger" %} ### Delivery & Read Reports are not support for WhatsApp Groups {% endhint %} ### Variables | Variable | Type | Description | | --------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **project\_id** | numeric | Your Project ID | | **event\_id** | numeric | 1 = Delivery Report | | **data** | Array | Array Contains Delivery Reports | | **push\_id** | numeric | Unique ID given as response to the Push API | | **number** | numeric | Mobile Number | | **msg\_id** | numeric | Unique ID associated to each number | | **status** | numeric |

0 = Unknown Status

1 = Delivered

2 = Failed

3 = Read (Not supported in phone automation)

4 = Submitted (Message submitted to Channel and got acknowledgment)
5 = Refunded (The credit debited if any for the message is refunded back to the Picky Assist Account - Consider the message as Failed)

| | **reference\_number** | String | Value passed by you through Push API | | **error\_code** | numeric | [**Please click here to read more**](https://help.pickyassist.com/api-documentation-v2/references/status-and-error-codes) | | **error\_message** | string | If the message status is Failed, Refunded then it will contain the reason of message failure, Error messages are not supported for all Channels, currently only for WhatsApp Official & Shared Channel support error messages. | | **message** | string | Content of the entire message that has been sent. | | **message\_type** | string |

Message Types indicate the type of the message. For example, if the message is text, then it will be shown as Text.

Message Types :


Text, Image, Audio ,Video and Document.

| | **media** | string | URL of the media that you have sent in the message. | | **channel\_id** | numeric |

ID of the channel through which the message was sent

5 = Facebook Messenger

8 = WhatsApp Official

10 = WhatsApp Web Automation

11 - Instagram

101 – WhatsApp Cloud API

121 – WhatsApp Official Managed Service

If you have connected multiple channels or using WhatsApp Cloud api then please get the channel id from your project under Settings -> Channels

| | **agent\_id** | numeric | Unique ID of the Agent/User who sends the message. | | **template\_id** | numeric | Unique ID of the template which has been sent. | | **source** | string |

Source of the message which is from where the message is sent.

For example, if the message is sent through Teambox, then it will be displayed as Teambox.

| | **chatbot\_id** | numeric | In case the message has been sent from Chatbots, Workflows or Funnels, then the respective Unique ID of the Flows will be displayed. | | **connector\_id** | numeric | In case the message has been sent from Connector, then the respective Unique ID of the Connector will be displayed. | ## WhatsApp Filter Report Event i.e event\_id = 2 This event helps you to get the whatsapp number filter reports pushed directly to your application when its available with us ### Variables | Variable | Type | Description | | --------------------- | ------- | --------------------------------------------------------------------------------- | | **project\_id** | numeric | Your Project ID | | **event\_id** | numeric | 2 = WhatsApp Filter Report | | **data** | Array | Object Contains WhatsApp Filter Delivery Reports | | **push\_id** | numeric | Unique ID given as response to the Push API | | **number** | numeric | Mobile Number | | **msg\_id** | numeric | Unique ID associated to each number | | **status** | numeric |

0 = Unknown Status

1 = WhatsApp Number

2 = Non WhatsApp Number

| | **reference\_number** | String | Value passed by you through Push API | | **error\_code** | numeric | Future Scope | | **error\_message** | string | Future Scope | ## WhatsApp Group Events i.e event\_id = 3 This event helps you to get the updates when a new member is joined in a group or exited from the group. {% hint style="warning" %} ### Supports Only in WhatsApp Web Automation {% endhint %} ### Variables | Variable | Type | Description | | ------------------ | ------- | --------------------------------------------------- | | **project\_id** | numeric | Your Project ID | | **event\_id** | numeric | 3 = WhatsApp Group Event | | **action** | numeric |

1 = New Member Added

2 = Member Exited

| | **group\_id** | string | Unique ID of the Group | | **group\_subject** | string | Subject of the Group | | **number** | numeric | WhatsApp Number of the member | | **application** | numeric | 10 = WhatsApp Web Automation | ## New Subscriber Alert i.e event\_id = 4 This event will get triggered whenever you have a new subscriber in any of the connected channels in your projects. ### Variables | Variable | Type | Description | | ------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | **project\_id** | numeric | Your Project ID | | **event\_id** | numeric | 5 | | **subscriber\_id** | string | Unique Id allocated by Picky Assist for each subscriber | | **mobile** | string | Mobile Number of the Subscriber if available, for facebook and web this will be blank | | **name** | string | Name of the subscriber if available , not supported in Phone Automation | | **email** | string | Email of the subscriber if available | | **profile\_pic** | string | Profile picture of the subscriber if available (not supported in phone automation) | | **channel** | numeric |

Which Channel the message is received

1 = Whatsapp Personal (Phone Automation)
2 = Whatsapp Business (Phone Automation)
3 = SMS (Phone Automation)
4 = Call (Phone Automation)

5 = Facebook Messenger

8 = WhatsApp Official
10 = WhatsApp Web Automation

Shared Number

919737001155 = Shared Number India
556140404433 - Shared Number Brazil

| | **message** | string | The first message the subscriber sent | | **date** | string |

Date & Time in your timezone as per the ISO 8601 Standard

2020-05-29T16:01:06+05:30

YYYY-MM-DDThh:mm:ssTZD

| --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://help.pickyassist.com/api-documentation-v2/event-webhook/event-webhook-variables.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.