Get Bot Postback List via WhatChimp API

Retrieve all bot flow postback IDs — needed for binding Quick Reply buttons to bot flows.

Updated 5 February 2026

Retrieve the list of all bot postback actions configured in your WhatsApp bot flows. Postbacks are the triggers that connect interactive buttons, Quick Reply templates, and menu options to specific bot flows.

Before you begin: Make sure you have your API key and phone number ID. See Getting Started with WhatChimp Developer API for setup instructions.

What Are Postbacks?

Every bot flow you create in WhatChimp has a postback ID — a unique identifier that triggers that specific flow. Postbacks are used when:

Binding Quick Reply buttons on template messages to bot flows (see Send Template Messages with Quick Reply Buttons)
Triggering bot flows programmatically from your own system
Mapping interactive menu buttons to specific responses

Endpoint

GET/POST /api/v1/whatsapp/get/post-back-list

https://app.whatchimp.com/api/v1/whatsapp/get/post-back-list

Parameters

Parameter	Type	Required	Description
`apiToken`	String	Yes	Your WhatChimp API key
`phone_number_id`	String	Yes	Your WhatsApp phone number ID

Request Examples

GET:

https://app.whatchimp.com/api/v1/whatsapp/get/post-back-list?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID

POST (cURL):

curl -X POST \
  'https://app.whatchimp.com/api/v1/whatsapp/get/post-back-list' \
  -d 'apiToken=API-KEY' \
  -d 'phone_number_id=PHONE-NUMBER-ID'

Response

{
  "status": "1",
  "message": [
    {
      "id": 671,
      "postback_id": "QUICK_REPLY_LOCATION_REPLY_BOT",
      "bot_name": "Location quick reply",
      "template_name": "Location quick reply",
      "visual_flow_type": "flow",
      "postback_type": "main"
    },
    {
      "id": 672,
      "postback_id": "QUICK_REPLY_ORDER_TRACKING",
      "bot_name": "Track Order Flow",
      "template_name": "Track Order Flow",
      "visual_flow_type": "flow",
      "postback_type": "main"
    }
  ]
}

Response Fields

Field	Description
`id`	Internal ID of the bot flow
`postback_id`	The unique postback identifier — this is what you pass in API calls
`bot_name`	Display name of the bot flow
`template_name`	Template name associated with the flow
`visual_flow_type`	Type of flow: `"flow"` (visual flow builder) or other types
`postback_type`	`"main"` for primary triggers

Using Postbacks with Quick Reply Templates

The most common use case for this endpoint is binding Quick Reply buttons to bot flows when sending template messages via API.

The flow:

Call GET /whatsapp/get/post-back-list to get all available postback IDs
Pick the postback IDs that match the bot flows you want each button to trigger
Pass them as a JSON array in template_quick_reply_button_values when sending the template

template_quick_reply_button_values=["QUICK_REPLY_ORDER_TRACKING", "QUICK_REPLY_LOCATION_REPLY_BOT"]

First postback ID maps to the first Quick Reply button, second to the second button, and so on.

For a complete walkthrough, see Send Template Messages with Quick Reply Buttons via WhatChimp API.

Send Template Messages with Quick Reply Buttons via WhatChimp API — Bind Quick Reply buttons to bot flows
How to Create a Keyword-Based WhatsApp Chatbot in WhatChimp — Build the bot flows that postbacks trigger
Getting Started with WhatChimp Developer API — API setup and authentication