Skip to main content

API Broadcasts

API Broadcasts let you send WhatsApp template messages from your own applications by combining a broadcast with an API Key. You create a broadcast linked to a template, then call the broadcast's webhook URL using your API key to send messages programmatically.

📸
Screenshot: API Broadcasts page showing the broadcast list
broadcasts-page.png
1. Go to Developer Tools → API Broadcasts
2. Capture the full page with header, search, and broadcast list
Save to: static/img/screenshots/dashboard/broadcasts-page.png

How it works​

1. Create an API Broadcast → linked to a WhatsApp template
↓
2. Create an API Key → with Broadcast scope (in API Keys page)
↓
3. Get the Webhook URL → unique URL for this broadcast
↓
4. Call the Webhook URL → from your CRM, website, or automation tool
↓
5. EzPulze sends the template message → to the contact's WhatsApp

An API Broadcast is essentially a bridge between your external system and EzPulze's messaging. It defines what to send (the template), and the API key defines who is allowed to send it.


What you need​

RequirementWhere to set it up
Approved WhatsApp templateWhatsApp Templates
API Key with Broadcast scopeAPI Keys
An external system to call the APIYour CRM, website, n8n, Zapier, or any HTTP client

Key features​

  • Webhook URL per broadcast — each broadcast gets a unique URL your system calls
  • API key authentication — secure access using your API key
  • Auto-generated cURL examples — ready-to-use code with your template's exact parameters
  • Agent assignment — assign agents to handle replies from broadcast recipients
  • Template linking — each broadcast maps to one approved WhatsApp template
  • Bulk status management — activate or deactivate multiple broadcasts at once

Broadcast types in the system​

The list page shows broadcasts from all sources. The type indicates how messages were sent:

TypeHow it's created
APICreated here — messages sent via webhook URL + API key
DirectAuto-created when messages sent from Chat page
ScheduledAuto-created from scheduled Compose Message broadcasts
AutomatedAuto-created by chatbot flows or drip campaigns
ManualAuto-created from immediate Compose Message sends
info

When you click Create API Broadcast, you create an API type broadcast. Other types are created automatically by other parts of the system and appear in this list for tracking purposes.


Getting started​

  1. Create a broadcast — step-by-step guide
  2. Create an API key — go to API Keys and create a key with Broadcast scope
  3. Get the webhook details — view the webhook URL and cURL example from the API key's documentation page
  4. Call the API — send a POST request with the contact's phone number and template parameters
tip

New to API integrations? Use the auto-generated cURL example from the API Documentation page to send a test message from your terminal before building it into your application.