capabilities.work

Provision Application and Send First Message

A 4-step recipe with Svix. We can help you get access.

Recipe · 4 steps

Provision Application and Send First Message

with Svix · Webhook & Event Subscription Management

Stand up an application with an endpoint and deliver a first webhook message.

  1. Create the application that owns the endpoint and messages. Svix returns either 200 or 201 with the new application object.
  2. Register a webhook endpoint on the application, subscribed to the supplied event type. Svix returns 201 with the new endpoint object.
  3. Publish a message of the subscribed event type to the application, which Svix fans out to matching endpoints. Returns 202 with the message object.
  4. List the delivery attempts recorded for the message so the caller can confirm the endpoint was invoked. Returns 200 with a paged attempt list.
What you'll need to have ready
  • applicationName: Human readable name for the new application (tenant).
  • applicationUid: Optional unique identifier for the application.
  • endpointUrl: The HTTPS URL the webhook endpoint will deliver events to.
  • eventType: The event type name the endpoint subscribes to and the message uses.
  • payload: The JSON payload delivered to subscribers for this message.
For your developer

Arazzo workflow svix:provision-and-send-message, 4 operations: v1.application.create → v1.endpoint.create → v1.message.create → v1.message-attempt.list-by-msg. Specs on APIs.io.