Peach
  1. messaging
Peach
  • messaging
    • Send a pre-approved template message
      POST
    • Poll template message status
      GET
    • Launch a broadcast
      POST
    • Poll broadcast status
      GET
    • Poll template messages status
      GET
  • contacts
    • Create a contact on Peach
      POST
  • orders
    • Create an order
      POST
    • Find order by ID
      GET
    • Create a refund for an order
      POST
  • medias
    • List available medias
      GET
    • Add a media
      POST
    • Remove a media
      DELETE
  • webhooks
    • Order status webhooks
    • Flow execution status webhooks
    • Message delivery status webhooks
    • AI flow execution status webhooks
  1. messaging

Poll template message status

GET
https://app.trypeach.io/api/v1/events/{{event_id}}
messaging
Poll the status of the event used to send a template message to a contact.
The field at the $.result.status JSONPath corresponds to the WhatsApp message status of the template message.

Request

Authorization
Add parameter in header
Authorization
Example:
Authorization: ********************

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://app.trypeach.io/api/v1/events/{{event_id}}' \
--header 'Authorization;'

Responses

🟢200Success
application/json
Body
id
string 
required
status
string 
required
result
object  | null 
required
type
enum<string> 
required
Allowed value:
template_message
id
string 
required
failure_message
string  | null 
required
liquid_values
object  | null 
required
An object containing key/value pairs of variables used as part of the template message.
Example:
{"invoice": "₹1,000"}
publish_status
enum<string> 
required
Allowed values:
draftqueuederrored
status
enum<string>  | enum<null> 
required
Allowed values:
sentdeliveredfailedread
created_at
string 
required
updated_at
string 
required
whats_app_template
object 
required
contact
object 
required
Examples
{
    "id": "evt_1234abcd",
    "status": "processed",
    "result": {
        "type": "template_message",
        "id": "cmsg_1234abcd",
        "failure_message": null,
        "liquid_values": {
            "invoice_amount": "₹1000.00"
        },
        "publish_status": "published",
        "status": "sent",
        "created_at": "2025-05-19T10:00:00Z",
        "updated_at": "2025-05-19T10:00:00Z",
        "whats_app_template": {
            "id": "wat_1234abcd",
            "template_name": "Test Template"
        },
        "contact": {
            "name": "John Doe",
            "email": "johndoe@example.com",
            "phone_number": "+919988776655"
        }
    }
}
Previous
Send a pre-approved template message
Next
Launch a broadcast
Built with