← All action domains

Events

1 operation. Call each with POST https://app.chirply.io/api/v1/actions/<name> and a bearer token; the response is { "data": { "action", "summary", "result" } }. A read badge means the operation changes nothing; write requires the credential’s write scope.

Emit an app event

events.emitwrite

Fire one of your app's own events into the account. Any automation whose trigger is 'App event' (matched to your app + this event key) runs. Use it to let people build workflows that start when something happens in your app. Needs the events:write scope.

Parameters

FieldTypeRequiredDescription
keystringrequiredYour event key, e.g. 'subscription_renewed'. What workflows match on.
contact_idstring (uuid)optionalThe contact this event is about, so contact-scoped workflows enroll them.
datamap of string → objectoptionalExtra event context (available to the workflow). Default: {}

Example

curl -X POST https://app.chirply.io/api/v1/actions/events.emit \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "key": "example"
  }'
Test with your API key

Over MCP the same operation is the tool events_emit at https://app.chirply.io/api/mcp, same bearer token, same input.

The machine-readable version of this page is GET https://app.chirply.io/api/v1/actions?domain=events — same operations, with full JSON Schemas. Authentication, errors and rate limits are covered in the API documentation home.