SVsvix
Message

Create Message Precheck

Changed on

A pre-check call for message.create that checks whether any active endpoints are listening to this message.

Note: most people shouldn't be using this API. Svix doesn't bill you for messages not actually sent, so using this API doesn't save money. If unsure, please ask Svix support before using this API.

post/api/v1/app/{app_id}/msg/precheck/active

Request

  • Base URL
    https://api.eu.svix.com
  • URL
    https://api.eu.svix.com/api/v1/app/{app_id}/msg/precheck/active
  • Auth
    HTTP bearer

Path parameters

app_idstring required

The Application's ID or UID.

Example:unique-identifier

Headers

idempotency-keystring

The request's idempotency key

Request body

channelsstring[] nullable
eventTypestring required

The event type's name

Example request

{
  "channels": [
    "project_123",
    "group_2"
  ],
  "eventType": "user.signup"
}

Response

activeboolean required

Whether there are any active endpoint that would get sent such a message.

Changes