Send a custom event into the product's Journeys.

Requires automation:execute. The event arrives on the product's implicit "Banger API events" incoming webhook, created on the first event and listed with the other webhooks so Journeys can name its connection_id, or on connection_id, another active incoming webhook of the same product. From there it is processed exactly like an event posted to that webhook's URL: active Journeys whose trigger names the event type and connection enroll the person at email (or their configured audience), and Journeys whose goal names it stop that person's runs. Events can start already-approved Journeys, which send email. The event id makes the call idempotent: repeating it with the same body returns duplicate true; reusing it for a different body returns 409 webhook_event_id_reused.

post/v1/workspaces/{workspaceId}/events

Request

  • Base URL: https://api.bangermail.com
  • URL: https://api.bangermail.com/v1/workspaces/{workspaceId}/events
  • Auth: HTTP bearer

Request body

typestring required

Event name that Journey triggers and goals match, such as signup.

emailstring email

The person the event is about.

namestring

The person's display name.

occurred_atstring date-time

When the event happened. Defaults to when Banger receives it.

attributesobject

Values Journey conditions and email content can read. Text values hold at most 500 characters.

connection_idstring uuid

An active incoming webhook connection of the same product. Defaults to the Banger API events webhook.

Response

Event accepted, or already accepted under this id.

Changes

No recorded changes to this operation across all 1 revision of this API.