Create Message

POST {{baseUrl}}/api/v1/app/:app_id/msg?with_content=true

Creates a new message and dispatches it to all of the application's endpoints.

The eventId is an optional custom unique ID. It's verified to be unique only up to a day, after that no verification will be made. If a message with the same eventId already exists for any application in your environment, a 409 conflict error will be returned.

The eventType indicates the type and schema of the event. All messages of a certain eventType are expected to have the same schema. Endpoints can choose to only listen to specific event types. Messages can also have channels , which similar to event types let endpoints filter by them. Unlike event types, messages can have multiple channels, and channels don't imply a specific message content or schema.

The payload property is the webhook's body (the actual webhook message). Svix supports payload sizes of up to ~350kb, though it's generally a good idea to keep webhook payloads small, probably no larger than 40kb.

Request Params

| Key | Datatype | Required | Description | | with_content | boolean | | When true message payloads are included in the response |

Request Body

{"eventType"=>"<string>", "payload"=>"<object>", "eventId"=>"<string>", "channels"=>["<string>"], "payloadRetentionPeriod"=>90, "application"=>{"name"=>"<string>", "rateLimit"=>"<uint16>", "uid"=>"<string>"}, "tags"=>["<string>"], "transformationsParams"=>"<object>"}

HEADERS

| Key | Datatype | Required | Description | | idempotency-key | string | | The request's idempotency key | | Content-Type | string | | | | Accept | string | | |

RESPONSES

status: ``