Introducing Event Destination API endpoints
You can now create and manage event destinations using the Event Destination API endpoints:
| Endpoint | What it does |
|---|---|
| Create Destination | Creates a destination and returns its signing secret. |
| Retrieve Destination | Returns one destination's full configuration and status. |
| List Destinations | Returns every destination in your account. You can filter by status or eventType. |
| Update Destination | Changes a destination's name, URL, event types, description, or status. |
| Delete Destination | Permanently deletes a destination and stops all deliveries. |
| Retrieve Destination Secret | Returns a destination's current signing secret. |
| Rotate Destination Secret | Replaces a destination's signing secret. |
An event destination is a configured webhook URL that Stedi sends events to when something in your account changes. For example, if you're building or maintaining an EHR, you can use event destinations to notify providers when transaction enrollments are complete.
Stedi signs every event with a secret that's unique to the destination. You use that signing secret to confirm the event came from Stedi.
Previously, you could only review events using the List Events and Retrieve Event API endpoints.
To manage event destinations or rotate signing secrets, you had to use the Stedi portal. You couldn't script the setup of event destinations for different environments. You couldn't rotate secrets on a fixed schedule.
Now, you can also manage event destinations programmatically from an application or script. For example, you can create destinations as part of your deployment scripts. You can also rotate every destination's secret using a scheduled job.
If you're a Stedi app developer, you can use these API endpoints to configure event destinations for your providers' accounts.
Availability and pricing
The new Event Destination API endpoints are available for free on all Stedi production accounts. There is no cost for event destinations or event deliveries.
For more information, including request examples and an OpenAPI spec, see our API reference.
Get started
To get started with Stedi, sign up for a free sandbox account. It takes less than two minutes. No credit card is required.
When you're ready, upgrade to production on our pay-as-you-go plan. There are no monthly minimums or setup fees. You only pay for the transactions you use.