Event Webhook Variables

Variables used for event webhook

Event Webhook Variables keep changing based on the type of event , below are currently available events

Event

Details

Event ID

​Delivery Report​

Delivery Report Event

1

​WhatsApp Filter​

WhatsApp Filter Event

2

​WhatsApp Group ​

WhatsApp Group Member Join & Exit Event

3

​New Subscriber Alert​

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

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)

error_code

numeric

Future Scope

error_message

string

Future Scope

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

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.

Supports Only in WhatsApp Official Account

Variables

Variable

Type

Description

project_id

numeric

Your Project ID

event_id

numeric

3 = WhatsApp Group Event

event

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

8 = WhatsApp Official

​

New Subscriber Alert i.e event_id = 4

This event will get triggered whenever you have a new subscriber in any of the connected channel 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 avaiablle, 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

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 Shared Number 919737001155 = Shared Number India 556140404433 - Shared Number Brazil

​

Coming Soon Services 6 = Telegraph 7 = Web

message

string

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