---
title: "Create a test callback event"
method: POST
path: "/companies/{company_key}/config/callback_events/test"
tags: ["Callback API"]
---

# Create a test callback event

`POST /companies/{company_key}/config/callback_events/test`

## Request

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

## Path parameters

- `company_key` string, required

## Headers

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

## Request body

- union
  - TestcallbackRequestAck
    - `callback_type` 'ack_participant_added' | 'ack_participant_changed' | 'company_participant_added' | 'company_participant_changed', required: The type of callback you'd like to receive the test callback for.
    - `participant` object
      - `id` string: person_id of person who is being added or removed from this acquisition campaign.
      - `mobile_phone` object
        - `mdn` string: Mobile phone number for person who is being added or removed from this acquisition campaign.
      - `acquisition_campaign` object
        - `api_key` string, required: This is the <b>acquisition_id</b> of the campaign a person is being added to. If using ack_participant_added or ack_participant_changed, api_key is required.
        - `description` string: The value here will be returned in the callback. This is optional.
        - `keyword` string: The value here will be returned in the callback. This is optional.
      - `subscription_list` object
        - `id` string: The subscription_list_id of the list the participant is being added to.
  - TestcallbackRequestEvent
    - `callback_type` 'event_processed', required: The type of callback you'd like to receive the test callback for.
    - `event_processed` object
      - `event_id` string: event_id for your test event.
      - `event_data` object: Enter any event_data that will be passed along in your test callback.
  - TestcallbackRequestPerson
    - `callback_type` 'person_added' | 'person_updated', required: The type of callback you'd like to receive the test callback for.
    - `person` object
      - `person_id` string: person_id for person being added or updated.
      - `external_person_id` string: external_person_id for person being added or updated.
      - `mobile` object
        - `mdn` string: Mobile phone number of person being added or updated.
        - `carrier_code` string: <a href="https://developer-aggregation.vibes.com/reference/carrier-codes">Carrier code</a> for person's mobile phone carrier.
      - `custom_fields` object: Any custom fields being added or updated for the person.
  - TestcallbackRequestPush
    - `callback_type` 'device_added' | 'device_removed' | 'device_updated', required: The type of callback you'd like to receive the test callback for.
    - `person` object
      - `person_id` string: person_id for the person associated with the push device being added/updated/removed.
      - `external_person_id` string: external_person_id for the person associated with the push device being added/updated/removed.
    - `push_device` object
      - `app_id` string: Your app id.
      - `vibes_device_id` string
      - `push_token` string
      - `device_os` string
  - TestcallbackRequestSub
    - `callback_type` 'subscription_added' | 'subscription_removed', required: The type of callback you'd like to receive the test callback for.
    - `subscription` object
      - `person` object
        - `id` string: person_id for the subscriber.
      - `subscription_list` object, required
        - `id` string, required: subscription_list_id for list for which a subscriber is being added or removed.
  - TestcallbackRequestSubList
    - `callback_type` 'subscription_list_added' | 'subscription_list_updated', required: The type of callback you'd like to receive the test callback for.
    - `subscription_list` object
      - `id` string: subscription_list_id for the list that is being added or updated.
      - `name` string: Name of subscription list being added or updated.

## Response `200`

Successful response

- TestCallbackResponse
  - `message` string: confirmation of test callback type requested.
  - `event_id` string: System defined event_id for the callback.

## Other responses

- `201`: The callback was queued for send.
- `404`: An active callback does not exist.

## Changes

- **2026-11-03** `e235838f2e50`: 1 breaking
  - the request property `oneOf[subschema #1: Acquisition Callbacks]/participant/acquisition_campaign/api_key` became required

[Operation history](https://skmtc.dev/vibes/apis/vibes-platform-api/changes/companies/:company_key/config/callback_events/test/post.md)

---

[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)