Test an event streaming destination connection

post/v1/projects/{project_id}/destinations/{id}/test

Authorizations

Authorizationstringrequired

http

Path parameters

project_idstringrequired

Amplitude project identifier, backed by the canonical app ID.

Example:12345

Constraints:pattern: ^[0-9]+$

idstringrequired

Destination id.

Constraints:min length: 1

Body

application/json

test_event_payloadstring

JSON event to send to the destination. Omit the field to use the partner's example event. An empty string is rejected.

Constraints:min length: 1

Response

application/json

200· Test result.

dataobjectrequired

Show child attributes

okbooleanrequired

detailstring

Constraints:nullable

example_payloadoneOf

Constraints:objectnull

Test an event streaming destination connection

curl -X POST "https://developer-api.amplitude.com/v1/projects/12345/destinations/{id}/test" \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_API_KEY"

Was this helpful?