API Reference

Create an event

post
https://public-api.vibescm.com/companies//events
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Request

If you are using Version 1 of the APIs, you cannot use the E.164 MDN international format. If you do use it, you will get an error returned.

Notes:

  • The Event API will accept 300 requests/second. If you anticipate greater volume, consider using a message queue to send the requests so retries and throttling can be applied if necessary.

Response

If the submission is successful, an abbreviated event JSON block will be returned, containing the event_id for the event.

Notes:

  • An HTTP 202 - Accepted response will be 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.
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
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 17 days ago

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

Updated 17 days ago