API Reference

Create an event

post
https://public-api.vibescm.com/companies//events

Inform Vbes that an event has occurred in an external system, thus triggering any event-triggered messages set up to be triggered as a result of the event.

Path Params
string
required
Important: Please note that the "Try It" feature to the right will send an actual API call to our system, which may result in a new event being created.
Body Params
string

Optional user-defined event id.

string
required

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

event_data
object
required

Note: Use one: mdn, person_id/person_key, external_person_id, or vibes_device_id.

Headers
string
required
string
Defaults to 1
Responses

202

Returned if the event has been successfully submitted but will not necessarily result in a message. To track whether or not your message was sent and received by the end user, we recommend registering for Event-Triggered Callbacks.

Updated 8 months ago

Language
Credentials
Basic
base64
:
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 8 months ago