Fire an event that triggers matching automations.

post

https://api.wrappedgiftcards.com/api/AutomationTriggerEvents

Every active automation on this account whose trigger type is ApiEvent and whose EventName matches the submitted event_name is fired. Each firing creates a gift card (using the automation's configured amount, unless overridden by the amount field) and dispatches the automation's email to the recipient_email.

Supply idempotency_key to make retries safe — a second call with the same key for the same automation is a no-op.

Supply properties to attach custom metadata to the created gift card. Any property is usable in the automation email as {{event.<key>}}.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Payload for firing an automation-trigger event.

event_name

string | null

Name of the event. Matches automations configured with the same EventName.

recipient_email

string | null

Recipient email address the gift card is issued to.

amount

double | null

Optional. Amount to award. Overrides the automation's configured amount when provided.

idempotency_key

string | null

Optional. Idempotency key. If the same value is submitted twice for the same automation the second call is a no-op.

properties

object | null

Optional. Custom properties to persist on the created gift card and usable as {{event.<key>}} merge tags in the automation's email.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

200Event processed. Returns the created gift cards and per-automation firing status.

400Missing or invalid required fields.

401Missing or invalid x-api-key.

404Account not found.

`x-api-key`.