Register Event Type and Send Example
A 3-step recipe with Svix. We can help you get access.
Recipe · 3 steps
Register Event Type and Send Example
with Svix · Webhook & Event Subscription Management
Define an event type, subscribe an endpoint, and deliver its example message.
- Register the event type in the environment catalog. Svix returns 201 with the new event type object.
- Create an endpoint on the application that filters on the new event type. Returns 201 with the endpoint object.
- Ask Svix to deliver the event type's built-in example payload to the endpoint to verify the subscription. Returns 202 with the message object.
What you'll need to have ready
- appId: The id or uid of the application to attach the endpoint to.
- eventTypeName: The unique event type name (e.g. "invoice.paid").
- eventTypeDescription: Human readable description of the event type.
- endpointUrl: The HTTPS URL the endpoint delivers events to.
For your developer
Arazzo workflow svix:register-event-type-and-send, 3 operations: v1.event-type.create → v1.endpoint.create → v1.endpoint.send-example. Specs on APIs.io.