Peach icon

Peach

Interact with the Peach WhatsApp Platform API

Actions17

Broadcast → Get Event Status

AI-generated

Summary

Fetches the status of a broadcast launch event from the Peach WhatsApp API by event ID. Use it to check progress or outcome after launching a broadcast.

Inputs

  • Event ID (required) — Unique ID of the launch event, as returned when a broadcast is launched. Sent in the URL path of GET /api/v1/events/{eventId}.
  • Request Options — Optional node settings: batching (items per batch, interval in ms), ignore SSL certificate issues, HTTP proxy URL, and request timeout in ms (default 10000).

Output shape

The JSON response from the Peach API for the event, describing its status. Returned as the node's output item.

The source declares no response transformation, so the exact fields depend on the Peach API. Requests use the peachApi credential against https://app.trypeach.ai. API errors cause the node to fail unless continue-on-fail is set.

Examples

Example 1: Poll a broadcast launch after starting it

Resource: Broadcast, Operation: Get Event Status, Event ID set by expression to the ID returned from the preceding Launch node.

Example 2: Check a known event manually

Event ID: a pasted event ID string; default request options.

Links

Discussion