Outbound triggers

Fire an outbound trigger for one phone number

Dispatches through the same path as a Shopify or webhook-raised event, so the trigger's filters, dedupe window, and rate limit all apply.

202 means the call was queued. A 200 means the request was valid but the trigger chose not to call — data.status is filtered or deduped and data.reason says why. Neither is an error, so a client should not retry on them.

post/outbound-triggers/{id}/fire

Request

  • Base URL: https://api.flogpt.com/api/v1
  • URL: https://api.flogpt.com/api/v1/outbound-triggers/{id}/fire
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Path parameters

idstring required

Resource identifier. Where a resource also has a public identifier — widgetId, callWidgetId, or a carrier call sid — either form is accepted.

Request body

tostring required

E.164 destination number.

contactNamestring

Used by the agent to greet the person by name.

eventKeystring

Deduplication key. Repeat fires with the same key inside the trigger's dedupe window return deduped. Omit to skip deduplication.

metadataobject

Merged into call metadata and exposed to the call script.

payloadobject

Event body used to evaluate the trigger's filters and templates.

dryRunboolean

Record and evaluate the event without placing a call.

Example request

{
  "to": "+14155550142"
}

Response

Not called — filtered or deduped

Changes

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