Picky Assist Help Desk
Main WebsiteBlogFacebook Community
Picky Assist Help Desk
Picky Assist Help Desk
  • Welcome To Picky Assist 🙏
  • Setting Up Guide
    • Sending First Message
    • Connecting Channels
      • WhatsApp Web Automation to Official API Migration Guide 2024
      • Connecting WhatsApp Web Automation
      • Connecting Facebook Messenger
        • Introduction
        • Getting Start
        • Guidelines & Compliances
        • Messenger Link
      • Connecting WhatsApp Official
        • Introduction
        • Dashboard
        • Profile
        • Templates
      • Connecting WhatsApp Cloud API
      • WhatsApp Official Managed Service
      • Connecting Instagram
      • Phone Bridge (Call Blaze)
      • Connecting SMTP
      • Connecting Amazon SES
      • Connecting Sendgrid
      • Connecting Additional WhatsApp Numbers
      • Porting WhatsApp Number to Picky Assist
      • WhatsApp Official Message Delivery Issues & Solutions
    • Working With Prebuilt CRM Modules
      • Introduction
      • Onboarding
      • Modules
        • Leads
        • Deals
        • Meetings
        • Company
        • Support Cases
        • System Modules
          • Contacts
          • Notes
          • Task
          • Call Logs
          • Tags
          • Activity Logs
      • Automations
        • Workflows
        • Chatbots
        • Funnels
        • Connectors
        • Scheduler
        • Other Prebuilt Features
      • Reports and Dashboard
      • Mandatory Preconditions for Using Prebuilt
      • Testing Prebuilt
    • Managing Organization
    • Setting Up Teambox
      • Introduction
      • Routing Rules
      • Teambox
      • Inbox View
      • Organization Hierarchy
      • Analytics
    • Setting Up Smart Replies
      • Introduction
      • Train Module
        • Training Bot Introduction
        • Topics / Categories
        • Intent & Context
        • Question Variations
        • Uploading Bulk Questions
        • Reply with Media Files
        • Personalising Replies
        • Smart Actions
        • Direct URL
        • Fall Back Response
        • Small Talks
        • Testing the Bot
        • Publishing Bot
      • ChatGPT Integration
      • Learn Module
      • Stats Module
      • Deep Linking
      • Settings
    • Smart Reply V2
      • Introduction
      • ChatGPT Integration
      • Train Module
        • Training Bot Introduction
        • Topics / Categories
        • Intent & Context
        • Question Variation
        • Uploading Bulk Questions
        • Reply with Media Files
        • Personalizing Replies
        • Smart Actions
        • Direct URL
        • Fall Back Response
        • Small Talks
        • Publishing Bot
      • Learn Module
      • Stats Module
      • Deep Linking
      • Settings
    • Setting Up Broadcaster
      • Introduction
      • Creating a Campagin
      • Sending Message to WhatsApp Groups
      • Reports
      • Broadcaster V2
        • Introduction
        • Creating Campaign
        • Reports
    • Setting Up Sequence
      • Introduction
      • Creating New Sequence
      • Sequence Stats
      • Subscribe & Unsubscribe
      • Disabling Sequence Message
    • Setting Up Reminder
    • Setting Up Mobile App
    • Setting Up Connector
      • Introduction
      • Getting Started
      • Steps
        • Introduction
        • Filters
        • Delay
        • Iterator
        • Stats
      • Actions
      • Formatter
        • Date & Time
        • Counter
        • Math Calculation
        • Data Parser
        • Convert File
        • Line Items
      • Building Mini App
      • Email Parser
      • Data Storage
      • Simulate Test
      • Connector Logs
    • Email Builder
    • Setting Up Flow Builder
      • Fundamentals (Must Read)
      • Basic Terminology (Must Read)
      • Guide to Building an Effective Chatbot (Must Read)
      • Create, Manage, Test & Publish Flows
      • Triggering a Chatbot Flow
      • Steps
        • Introduction (Must Read)
        • Send Message
        • Ask A Question
        • Filter
        • Save Data
        • Actions
        • Check WhatsApp Session
        • Delay
        • Smart Delay
        • Formatter
        • Splitter
        • Data Lookup
        • Trigger HTTP API
        • Webhook
        • Apps
        • Match Keywords
        • Route to Chatbot
        • End
      • Saving Data into CRM
      • Analytics
      • Integrations
      • Flow Builder logs and conversational logs
      • Chatbot Best Practices, Ideas & FAQ
    • Setting up Modular CRM
      • Fundamentals (Must Read)
      • Guide to Building and Implementing a Modular CRM (Must Read)
      • Create & Manage Data Modules
      • CRM Macro Buttons
      • Adding Records into CRM
      • Data View & Manage Records
      • Task
      • Workflows
      • Funnels
      • Data Import
      • Integrations
    • Setting Up Scheduler
    • Media Gallery
    • Quick Replies
    • Opt-out Settings
    • Blacklist
    • Global Variables
    • Setting Up Ad-On's
      • Setting Up WhatsMail
      • Setting Up Zendesk
      • Setting Up Zapier
      • Setting Up Zoho CRM
        • Getting Started
        • Working with Extension
        • Integrating with Zoho Workflow
        • Lead Assignment Rules
        • Integrating into Custom Modules
        • Connecting Multiple WhatsApp Numbers into Zoho CRM
        • Integrating WhatsApp with Zoho CRM Mobile App
        • Keyboard Shortcuts
      • Setting Up Facebook Lead Adform
      • Facebook Lead Ad form V2
      • Setting Up WhatsApp Web
      • Setting Up Pabbly Connect
      • Setting Up ChatGPT App
    • Google Chrome Extensions
      • Extension for Sending WhatsApp Messages from any Webpage
      • Chrome Extension V2
      • Extension for Zoho CRM & Teambox
    • Managing Profile
      • Two Factor Aunthentication
      • Login History
      • Delete Account
    • Quick Rollout Guide
      • WhatsApp Official Account
    • Developers & Partners Guide for Deep Integration of Picky Assist
  • API Documentation V2
    • Introduction
    • Quick Start Guide 🏃
    • Global Webhook
      • How Webhook Works
      • Webhook Variables
      • Configuring Webhook URL
      • Webhook Request & Response
      • Getting the Conversation Context
      • Testing Your Webhook
    • Event Webhook
      • How Event Webhook Works
      • Event Webhook Variables
      • Configuring Event Webhook URL
      • Event Webhook Sample Request & Response
    • Push API
      • Introduction
      • API Variables
      • Sending Single Message - Push
      • Sending Dynamic Messages – Push
      • Sending Media Attachments – Push
      • Sending Interactive List & Buttons
      • Sending Stickers
      • Sending Bulk Messages - Push
      • Sending Contacts
      • Sending Location
      • Sending WhatsApp Template Messages
        • Introduction
        • Sending WhatsApp Template Text Messages
        • Sending WhatsApp Template Image
        • Sending WhatsApp Template Document
        • Sending WhatsApp Interactive Buttons
        • Sending WhatsApp Limited Time Offer Templates
      • Sending Message to Groups
      • Sending SMS Using SIM Card
      • Sending Message to Facebook Messenger
      • Normal Post Method
      • Delivery Reports
      • Push API Must Read Instructions
      • Testing API Requests
    • WhatsApp Template API
      • Introduction
      • API Variables
      • Template Request API
      • Template Status API
      • Languages
      • Guidelines
    • WhatsApp Group API
      • Introduction
      • API Variables
      • Create Group
      • Set Group Permission
      • Add Group Admin
      • Add Group Members
      • Fetch Group Details
      • Update Group Info
      • Remove Group Members / Admin
      • Generate New Invite Link
      • Group Delete Actions
    • WhatsApp Settings API's
      • WhatsApp Profile API
      • 2 Step Verification
      • WhatsApp Status Update
      • WhatsApp Contact & Group Fetching
    • Device Manage API’s
      • Fetching Device Status API
      • Device Commands API’s
      • WhatsApp Automation Server Status API
    • Account API
      • Fetch Balance
    • Project Management API
      • Introduction
      • Create Project
      • Get Project Details
      • Set / Update Webhook
      • Create API Token
      • Manage API Token
      • Change Billing Plan
      • Fetch Account Balance
      • Country Code & Timezones
    • References
      • Status & Error Codes
      • Most Frequent Issues & Solutions
      • Formating & Sending Emojis 😊
      • Postman Collection for Picky Assist API's
      • High Volume Messaging Bots - WhatsApp
    • Sample Codes
      • PHP
      • Python
      • Node JS
      • Ruby
      • Java
      • ASP.NET Using C#
      • Javascript
      • Go
      • Swift
      • C
      • C#
      • Objective C
  • General Guidelines
    • Billing
    • Adding Money Into Account
    • Rate Limits
    • Character Limits WhatsApp
    • Best Practices for Media Handling
    • Roadmap
    • Features In the Early Beta Version
  • Changelog
    • 2021
      • February 2021
      • March 2021
      • April 2021
      • May 2021
      • June 2021
    • 2020
      • February 2020
      • March 2020
      • April 2020
      • May 2020
      • June 2020
      • September 2020
      • October 2020
    • 2019
      • November 2019
      • October 2019
      • August 2019
      • September 2019
Powered by GitBook
On this page
  • Delivery Report Event i.e event_id = 1
  • Variables
  • WhatsApp Filter Report Event i.e event_id = 2
  • Variables
  • WhatsApp Group Events i.e event_id = 3
  • Variables
  • New Subscriber Alert i.e event_id = 4
  • Variables

Was this helpful?

  1. API Documentation V2
  2. Event Webhook

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 Event

1

WhatsApp Filter Event

2

WhatsApp Group Member Join & Exit Event

3

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

Delivery & Read Reports are not support for WhatsApp Groups

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

Future Scope

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.

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.

Supports Only in WhatsApp Web Automation

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

PreviousHow Event Webhook WorksNextConfiguring Event Webhook URL

Last updated 3 years ago

Was this helpful?

Delivery Report
WhatsApp Filter
WhatsApp Group
New Subscriber Alert