---
title: "Create an event"
method: POST
path: "/companies/{company_key}/events"
tags: ["Event API"]
---

# Create an event

`POST /companies/{company_key}/events`

## Request

- Base URL: `https://public-api.vibescm.com`
- URL: `https://public-api.vibescm.com/companies/{company_key}/events`
- Auth: HTTP basic

## Path parameters

- `company_key` string, required

## Headers

- `Content-Type` string, required
- `X-API-Version` string

## Request body

- EventRequest
  - `event_id` string: Optional user-defined event id.
  - `event_type` string, required: Used to identify a linked API triggered campaign in the platform.
  - `event_data` object, required: <b>Note:</b> Use <i>one:</i> mdn, person_id/person_key, external_person_id, or vibes_device_id.
    - `mdn` string: Mobile Directory Number.
    - `person_id` string: A unique Vibes-asigned identifier for each person record. <b>Note:</b> You may use either `person_id` or `person_key` as the value in this key/value pair.
    - `external_person_id` string: A unique person identifier assigned by the brand and associted with a Vibes person records.
    - `vibes_device_id` string: Identifies a push-enabled device associated with a Vibes person record.

## Response `200`

Successful response

- EventResponse
  - `event_id` string: Unique identifier for the event triggered.

## Other 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 <a href="https://developer-platform.vibes.com/reference/event-triggered-callbacks">Event-Triggered Callbacks</a>.

---

[API](https://skmtc.dev/vibes/apis/vibes-platform-api.md) - [All operations](https://skmtc.dev/vibes/apis/vibes-platform-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vibes/apis/vibes-platform-api/revisions/e235838f2e50?raw)
