Skip to main content
POST
Authenticated with an event token (from Settings → Event tokens), not an API key. The event name becomes a trigger you can pick when building a playbook. Included with the Workflows add-on. Full guide: Event tokens.

​
Scenarios

An event is anything meaningful that happens on your site. It doesn’t have to be a SaaS app. Any website can send one: a form submit, a booked meeting, a purchase, a call. The name you send is the trigger.
Send form_submitted (or demo_booked) the moment someone converts on your site. It pulls them out of every cold campaign they’re in, so you’re not still cold-emailing a person who just raised their hand.
Send purchase (or order_placed) to stop any active outreach the instant money changes hands.
Any event your site or backend tracks works: quote_requested, call_booked, signed_up, a downloaded resource. Send it to start the right follow-up the moment it happens.
You can only trigger a playbook on an event you have already sent at least once. Send it here, then it appears in the trigger picker when you build a playbook.

​
Notes

  • email is the identity key. It’s how Squid ID knows which person the event is about. Use the same email your site knows them by. An event with no email is rejected.
  • One event does both jobs. It stops any playbook that exits on that event name AND starts any playbook triggered by it, each a no-op unless a playbook opts in.
  • Retention. Raw events are validated at the edge and purged after 24 hours. What persists is the effect (a playbook started or stopped) and the catalog of event names you’ve sent.
See the Event tokens guide for token management and language examples (Node, Python, PHP, Ruby).

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Authorization
string
required

Your Squid ID API key, format: Bearer <key> (keys start with sqid_).

Body

application/json
​
event
string
required

The event name (letters, numbers, _ . : -), up to 64 chars.

Example:

"signed_up"

​
email
string<email>
required

The person the event is about. The identity key.

Example:

"jane@acme.com"

​
properties
object

Optional context, one level deep. String, number, or boolean values.

Example:

Response

Accepted

​
ok
boolean