Skip to content

HTTP API

POST /ingest/v1/{app_id}/envelope

Send a batch of errors and product events (an Envelope)

Sent with: X-Ingest-Key

Body

Field Type Required
sdk Sdk
items ErrorItem or EventItem[] yes

Answers: 202

POST /ingest/api/{project}/envelope/

Send a Sentry envelope (official Sentry SDKs, set up with the app’s Sentry DSN)

Sent with: X-Sentry-Auth

Answers: 200, 429

POST /ingest/api/{project}/store/

Send one Sentry event (older Sentry SDKs)

Sent with: X-Sentry-Auth

Answers: 200, 429

POST /ingest/v1/{app_id}/debug-files

Upload a debug file (an R8 mapping, a source map or its minified file, a dSYM object) with the app’s server key

Sent with: authorization

Answers: 200, 201

Every SDK sends the person’s identity, events and consent here, with the same publishable key.

POST /sdk/v1/identify

Who the app’s user is; email and phone are hashed on arrival

Sent with: X-User-Hash, X-App-Install, X-App-Key

Body

Field Type Required
external_id string
email string
phone string
email_sha256 string
phone_sha256 string
attributes object

Answers: 200

POST /sdk/v1/events

What the identified user did

Sent with: X-User-Hash, X-App-Key

Body

Field Type Required
external_id string yes
events EventIn[] yes

Answers: 200

PUT /sdk/v1/consent

What the user agreed to, per channel

Sent with: X-User-Hash, X-App-Key

Body

Field Type Required
external_id string yes
channel push · in_app · email · whatsapp · sms · telegram yes
granted boolean yes
occurred_at string (date-time)

Answers: 200

POST /sdk/v1/install/events

What the app’s user did before the app identified them

Sent with: X-App-Install, X-App-Key

Body

Field Type Required
events EventIn[] yes

Answers: 200

PUT /sdk/v1/install/consent

What the app’s user agreed to before the app identified them

Sent with: X-App-Install, X-App-Key

Body

Field Type Required
channel push · in_app · email · whatsapp · sms · telegram yes
granted boolean yes
occurred_at string (date-time)

Answers: 200

POST /server/v1/identify

Create or update a profile by the match rule

Sent with: authorization

Body

Field Type Required
external_id string
email string
phone string
email_sha256 string
phone_sha256 string
attributes object

Answers: 200

POST /server/v1/events

Events, each naming its person

Sent with: authorization

Body

Field Type Required
events ServerEventIn[] yes

Answers: 200

POST /server/v1/orders

Orders; one sent again by its order_id is updated

Sent with: authorization

Body

Field Type Required
orders OrderIn[] yes

Answers: 200

PUT /server/v1/consent

What a person agreed to, per channel

Sent with: authorization

Body

Field Type Required
external_id string yes
channel push · in_app · email · whatsapp · sms · telegram yes
granted boolean yes
occurred_at string (date-time)

Answers: 200

POST /server/v1/import

A batch of end users as text/csv or application/json (at most 10,000 rows)

Sent with: authorization

Answers: 200

GET /server/v1/profiles/{external_id}

A person, by the org’s external id

Sent with: authorization

Answers: 200

DELETE /server/v1/profiles/{external_id}

Delete a person and everything about them; every service forgets them too

Sent with: authorization

Answers: 204