v1

latestOpenAPI 3.0.02026-07-267581167.5 KB

Event API

Create an event

post/companies/{company_key}/events

Path parameters

company_keystring required

<div style="color:#dd1e2e; background:url(https://d2xs7zaan7w9gl.cloudfront.net/data/pages/64014/widgets/48027d01-e827-45e0-b96d-227c1099eedc/image/1680214872.png?icon-24x24-warning.png) no-repeat 10px center; background-color:#FCEAEC; padding:10px; font-size:13px;"><div style="padding-left:35px"><b>Important:</b> Please note that the <b>"Try It"</b> feature to the right will send an actual API call to our system, which may result in a new event being created.</div></div>

Headers

Content-Typestring required

X-API-Versionstring

Request body

event_idstring

Optional user-defined event id.

event_typestring required

Used to identify a linked API triggered campaign in the platform.

Response

Successful response

event_idstring

Unique identifier for the event triggered.