The Destinations API from Stedi — 4 operation(s) for destinations.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/stedi-destinations-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
openapi: 3.2.0
info:
contact:
email: healthcare@stedi.com
description: 'The Stedi Events Service manages event destinations and event delivery.
It supports destination CRUD operations, secret management for signature verification,
event creation and management, and delivery tracking with resend capabilities.
'
license:
name: Proprietary
url: https://stedi.com
title: Stedi Event Destinations API
version: '2026-02-01'
servers:
- description: Production
url: https://events.us.stedi.com/2026-02-01
security:
- httpApiKeyAuth: []
tags:
- name: Destinations
paths:
/destinations:
get:
description: Lists all destinations configured for your account. Results are paginated.
operationId: EventDestinationsListDestinations
parameters:
- description: Number of items to return per page.
in: query
name: pageSize
schema:
description: Number of items to return per page.
maximum: 100
minimum: 1
type: number
- description: The `nextPageToken` value from a previous response. You can use this to get the next page of results. If not set, Stedi returns the first page of results.
in: query
name: pageToken
schema:
description: The `nextPageToken` value from a previous response. You can use this to get the next page of results. If not set, Stedi returns the first page of results.
maxLength: 1024
minLength: 1
type: string
- description: Filter results by destination status.
in: query
name: status
schema:
$ref: '#/components/schemas/DestinationStatus'
- description: Filter results by event type. Visit [event types](https://www.stedi.com/docs/healthcare/event-destinations-event-types) for a complete list.
in: query
name: eventType
schema:
description: Filter results by event type. Visit [event types](https://www.stedi.com/docs/healthcare/event-destinations-event-types) for a complete list.
maxLength: 255
minLength: 1
type: string
responses:
'200':
content:
application/json:
examples:
EventDestinationsListDestinations_example1:
description: ''
summary: List destinations
value:
items:
- createdAt: '2026-02-01T12:00:00Z'
description: Receives enrollment notifications
destinationUrl: https://example.com/webhooks
eventTypes:
- enrollment.activated
id: dst_550e8400-e29b-41d4-a716-446655440000
lastDeliveryTime: '2026-02-01T12:00:01Z'
name: My Destination
status: ENABLED
updatedAt: '2026-02-01T12:00:00Z'
schema:
$ref: '#/components/schemas/EventDestinationsListDestinationsResponseContent'
description: EventDestinationsListDestinations 200 response
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestExceptionResponseContent'
description: InvalidRequestException 400 response
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedExceptionResponseContent'
description: AuthenticationFailedException 401 response
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenExceptionResponseContent'
description: ForbiddenException 403 response
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsExceptionResponseContent'
description: TooManyRequestsException 429 response
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerExceptionResponseContent'
description: InternalServerException 500 response
tags:
- Destinations
post:
description: Creates an event destination. Returns destination details and a signing secret for verifying event payloads.
operationId: EventDestinationsCreateDestination
parameters:
- description: 'A unique string to identify this request to the server. If not set, Stedi generates one automatically.
The key can be up to 255 characters. You can safely retry requests with the same idempotency key within 24 hours of making the first request. This prevents duplicate operations due to network errors or other intermittent failures. [Learn more](https://www.stedi.com/docs/api-reference/index#idempotency-keys).'
examples:
EventDestinationsCreateDestination_example1:
description: ''
summary: Create a destination
value: a1b2c3d4-e5f6-7890-abcd-ef1234567890
in: header
name: Idempotency-Key
schema:
description: 'A unique string to identify this request to the server. If not set, Stedi generates one automatically.
The key can be up to 255 characters. You can safely retry requests with the same idempotency key within 24 hours of making the first request. This prevents duplicate operations due to network errors or other intermittent failures. [Learn more](https://www.stedi.com/docs/api-reference/index#idempotency-keys).'
maxLength: 255
minLength: 1
type: string
requestBody:
content:
application/json:
examples:
EventDestinationsCreateDestination_example1:
description: ''
summary: Create a destination
value:
destinationUrl: https://example.com/webhooks
eventTypes:
- enrollment.activated
name: My Destination
status: ENABLED
schema:
$ref: '#/components/schemas/EventDestinationsCreateDestinationRequestContent'
required: true
responses:
'201':
content:
application/json:
examples:
EventDestinationsCreateDestination_example1:
description: ''
summary: Create a destination
value:
createdAt: '2026-02-01T12:00:00Z'
description: Receives enrollment notifications
destinationUrl: https://example.com/webhooks
eventTypes:
- enrollment.activated
id: dst_550e8400-e29b-41d4-a716-446655440000
name: My Destination
signingSecret: whsec_YWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXoxMjM0NTY=
status: ENABLED
updatedAt: '2026-02-01T12:00:00Z'
schema:
$ref: '#/components/schemas/EventDestinationsCreateDestinationResponseContent'
description: EventDestinationsCreateDestination 201 response
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestExceptionResponseContent'
description: InvalidRequestException 400 response
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedExceptionResponseContent'
description: AuthenticationFailedException 401 response
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/EventDestinationsLimitExceededExceptionResponseContent'
description: EventDestinationsLimitExceededException 403 response
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictExceptionResponseContent'
description: ConflictException 409 response
'413':
content:
application/json:
schema:
$ref: '#/components/schemas/ContentTooLargeExceptionResponseContent'
description: ContentTooLargeException 413 response
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsExceptionResponseContent'
description: TooManyRequestsException 429 response
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerExceptionResponseContent'
description: InternalServerException 500 response
tags:
- Destinations
/destinations/{destinationId}:
delete:
description: Deletes an existing destination. This action is irreversible. Deleting a destination that is already deleted succeeds with the same response (idempotent).
operationId: EventDestinationsDeleteDestination
parameters:
- description: The unique identifier for the destination. You can retrieve destination IDs with the [List Destinations](https://www.stedi.com/docs/healthcare/api-reference/get-event-destinations-list-destinations) endpoint.
examples:
EventDestinationsDeleteDestination_example1:
description: ''
summary: Delete a destination
value: dst_550e8400-e29b-41d4-a716-446655440000
in: path
name: destinationId
required: true
schema:
description: The unique identifier for the destination. You can retrieve destination IDs with the [List Destinations](https://www.stedi.com/docs/healthcare/api-reference/get-event-destinations-list-destinations) endpoint.
pattern: ^[a-z]{3,5}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
type: string
- description: 'A unique string to identify this request to the server. If not set, Stedi generates one automatically.
The key can be up to 255 characters. You can safely retry requests with the same idempotency key within 24 hours of making the first request. This prevents duplicate operations due to network errors or other intermittent failures. [Learn more](https://www.stedi.com/docs/api-reference/index#idempotency-keys).'
examples:
EventDestinationsDeleteDestination_example1:
description: ''
summary: Delete a destination
value: c3d4e5f6-a7b8-9012-cdef-123456789012
in: header
name: Idempotency-Key
schema:
description: 'A unique string to identify this request to the server. If not set, Stedi generates one automatically.
The key can be up to 255 characters. You can safely retry requests with the same idempotency key within 24 hours of making the first request. This prevents duplicate operations due to network errors or other intermittent failures. [Learn more](https://www.stedi.com/docs/api-reference/index#idempotency-keys).'
maxLength: 255
minLength: 1
type: string
responses:
'204':
description: EventDestinationsDeleteDestination 204 response
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestExceptionResponseContent'
description: InvalidRequestException 400 response
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedExceptionResponseContent'
description: AuthenticationFailedException 401 response
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenExceptionResponseContent'
description: ForbiddenException 403 response
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundExceptionResponseContent'
description: NotFoundException 404 response
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictExceptionResponseContent'
description: ConflictException 409 response
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsExceptionResponseContent'
description: TooManyRequestsException 429 response
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerExceptionResponseContent'
description: InternalServerException 500 response
tags:
- Destinations
get:
description: Retrieves details for an existing event destination.
operationId: EventDestinationsGetDestination
parameters:
- description: The unique identifier for the destination. You can retrieve destination IDs with the [List Destinations](https://www.stedi.com/docs/healthcare/api-reference/get-event-destinations-list-destinations) endpoint.
examples:
EventDestinationsGetDestination_example1:
description: ''
summary: Get a destination
value: dst_550e8400-e29b-41d4-a716-446655440000
in: path
name: destinationId
required: true
schema:
description: The unique identifier for the destination. You can retrieve destination IDs with the [List Destinations](https://www.stedi.com/docs/healthcare/api-reference/get-event-destinations-list-destinations) endpoint.
pattern: ^[a-z]{3,5}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
type: string
responses:
'200':
content:
application/json:
examples:
EventDestinationsGetDestination_example1:
description: ''
summary: Get a destination
value:
createdAt: '2026-02-01T12:00:00Z'
description: Receives enrollment notifications
destinationUrl: https://example.com/webhooks
eventTypes:
- enrollment.activated
id: dst_550e8400-e29b-41d4-a716-446655440000
name: My Destination
status: ENABLED
updatedAt: '2026-02-01T12:00:00Z'
schema:
$ref: '#/components/schemas/EventDestinationsGetDestinationResponseContent'
description: EventDestinationsGetDestination 200 response
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestExceptionResponseContent'
description: InvalidRequestException 400 response
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedExceptionResponseContent'
description: AuthenticationFailedException 401 response
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenExceptionResponseContent'
description: ForbiddenException 403 response
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundExceptionResponseContent'
description: NotFoundException 404 response
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsExceptionResponseContent'
description: TooManyRequestsException 429 response
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerExceptionResponseContent'
description: InternalServerException 500 response
tags:
- Destinations
post:
description: Updates an existing destination configuration.
operationId: EventDestinationsUpdateDestination
parameters:
- description: The unique identifier for the destination. You can retrieve destination IDs with the [List Destinations](https://www.stedi.com/docs/healthcare/api-reference/get-event-destinations-list-destinations) endpoint.
examples:
EventDestinationsUpdateDestination_example1:
description: ''
summary: Update a destination
value: dst_550e8400-e29b-41d4-a716-446655440000
in: path
name: destinationId
required: true
schema:
description: The unique identifier for the destination. You can retrieve destination IDs with the [List Destinations](https://www.stedi.com/docs/healthcare/api-reference/get-event-destinations-list-destinations) endpoint.
pattern: ^[a-z]{3,5}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
type: string
- description: 'A unique string to identify this request to the server. If not set, Stedi generates one automatically.
The key can be up to 255 characters. You can safely retry requests with the same idempotency key within 24 hours of making the first request. This prevents duplicate operations due to network errors or other intermittent failures. [Learn more](https://www.stedi.com/docs/api-reference/index#idempotency-keys).'
examples:
EventDestinationsUpdateDestination_example1:
description: ''
summary: Update a destination
value: b2c3d4e5-f6a7-8901-bcde-f12345678901
in: header
name: Idempotency-Key
schema:
description: 'A unique string to identify this request to the server. If not set, Stedi generates one automatically.
The key can be up to 255 characters. You can safely retry requests with the same idempotency key within 24 hours of making the first request. This prevents duplicate operations due to network errors or other intermittent failures. [Learn more](https://www.stedi.com/docs/api-reference/index#idempotency-keys).'
maxLength: 255
minLength: 1
type: string
requestBody:
content:
application/json:
examples:
EventDestinationsUpdateDestination_example1:
description: ''
summary: Update a destination
value:
name: Updated Destination Name
status: DISABLED
schema:
$ref: '#/components/schemas/EventDestinationsUpdateDestinationRequestContent'
responses:
'200':
content:
application/json:
examples:
EventDestinationsUpdateDestination_example1:
description: ''
summary: Update a destination
value:
createdAt: '2026-02-01T12:00:00Z'
description: ''
destinationUrl: https://example.com/webhooks
eventTypes:
- enrollment.activated
id: dst_550e8400-e29b-41d4-a716-446655440000
name: Updated Destination Name
status: DISABLED
updatedAt: '2026-02-02T08:30:00Z'
schema:
$ref: '#/components/schemas/EventDestinationsUpdateDestinationResponseContent'
description: EventDestinationsUpdateDestination 200 response
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestExceptionResponseContent'
description: InvalidRequestException 400 response
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedExceptionResponseContent'
description: AuthenticationFailedException 401 response
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenExceptionResponseContent'
description: ForbiddenException 403 response
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundExceptionResponseContent'
description: NotFoundException 404 response
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictExceptionResponseContent'
description: ConflictException 409 response
'413':
content:
application/json:
schema:
$ref: '#/components/schemas/ContentTooLargeExceptionResponseContent'
description: ContentTooLargeException 413 response
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsExceptionResponseContent'
description: TooManyRequestsException 429 response
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerExceptionResponseContent'
description: InternalServerException 500 response
tags:
- Destinations
/destinations/{destinationId}/secret:
get:
description: Retrieves the current signing secret for a destination. Use this secret to verify the authenticity of event payloads.
operationId: EventDestinationsGetDestinationSecret
parameters:
- description: The unique identifier for the destination. You can retrieve destination IDs with the [List Destinations](https://www.stedi.com/docs/healthcare/api-reference/get-event-destinations-list-destinations) endpoint.
examples:
EventDestinationsGetDestinationSecret_example1:
description: ''
summary: Get destination secret
value: dst_550e8400-e29b-41d4-a716-446655440000
in: path
name: destinationId
required: true
schema:
description: The unique identifier for the destination. You can retrieve destination IDs with the [List Destinations](https://www.stedi.com/docs/healthcare/api-reference/get-event-destinations-list-destinations) endpoint.
pattern: ^[a-z]{3,5}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
type: string
responses:
'200':
content:
application/json:
examples:
EventDestinationsGetDestinationSecret_example1:
description: ''
summary: Get destination secret
value:
signingSecret: whsec_YWJjZGVmZ2hpamtsbW5vcHFyc3R1dnd4eXoxMjM0NTY=
schema:
$ref: '#/components/schemas/EventDestinationsGetDestinationSecretResponseContent'
description: EventDestinationsGetDestinationSecret 200 response
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestExceptionResponseContent'
description: InvalidRequestException 400 response
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedExceptionResponseContent'
description: AuthenticationFailedException 401 response
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenExceptionResponseContent'
description: ForbiddenException 403 response
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundExceptionResponseContent'
description: NotFoundException 404 response
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsExceptionResponseContent'
description: TooManyRequestsException 429 response
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerExceptionResponseContent'
description: InternalServerException 500 response
tags:
- Destinations
/destinations/{destinationId}/secret/rotate:
post:
description: Rotates the signing secret for a destination. The previous secret remains valid for the period specified by `previousSecretExpiryHours` (or `0` for immediate invalidation) to allow for a graceful transition.
operationId: EventDestinationsRotateDestinationSecret
parameters:
- description: The unique identifier for the destination. You can retrieve destination IDs with the [List Destinations](https://www.stedi.com/docs/healthcare/api-reference/get-event-destinations-list-destinations) endpoint.
examples:
EventDestinationsRotateDestinationSecret_example1:
description: ''
summary: Rotate destination secret
value: dst_550e8400-e29b-41d4-a716-446655440000
in: path
name: destinationId
required: true
schema:
description: The unique identifier for the destination. You can retrieve destination IDs with the [List Destinations](https://www.stedi.com/docs/healthcare/api-reference/get-event-destinations-list-destinations) endpoint.
pattern: ^[a-z]{3,5}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
type: string
- description: 'A unique string to identify this request to the server. If not set, Stedi generates one automatically.
The key can be up to 255 characters. You can safely retry requests with the same idempotency key within 24 hours of making the first request. This prevents duplicate operations due to network errors or other intermittent failures. [Learn more](https://www.stedi.com/docs/api-reference/index#idempotency-keys).'
examples:
EventDestinationsRotateDestinationSecret_example1:
description: ''
summary: Rotate destination secret
value: d4e5f6a7-b8c9-0123-defa-234567890123
in: header
name: Idempotency-Key
schema:
description: 'A unique string to identify this request to the server. If not set, Stedi generates one automatically.
The key can be up to 255 characters. You can safely retry requests with the same idempotency key within 24 hours of making the first request. This prevents duplicate operations due to network errors or other intermittent failures. [Learn more](https://www.stedi.com/docs/api-reference/index#idempotency-keys).'
maxLength: 255
minLength: 1
type: string
requestBody:
content:
application/json:
examples:
EventDestinationsRotateDestinationSecret_example1:
description: ''
summary: Rotate destination secret
value:
previousSecretExpiryHours: 24
schema:
$ref: '#/components/schemas/EventDestinationsRotateDestinationSecretRequestContent'
responses:
'200':
content:
application/json:
examples:
EventDestinationsRotateDestinationSecret_example1:
description: ''
summary: Rotate destination secret
value:
previousSecretExpiresAt: '2025-01-01T00:00:00Z'
signingSecret: whsec_bmV3c2VjcmV0Zm9ycm90YXRpb25leGFtcGxlMTIzNA==
schema:
$ref: '#/components/schemas/EventDestinationsRotateDestinationSecretResponseContent'
description: EventDestinationsRotateDestinationSecret 200 response
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestExceptionResponseContent'
description: InvalidRequestException 400 response
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/AuthenticationFailedExceptionResponseContent'
description: AuthenticationFailedException 401 response
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenExceptionResponseContent'
description: ForbiddenException 403 response
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundExceptionResponseContent'
description: NotFoundException 404 response
'409':
content:
application/json:
schema:
$ref: '#/components/schemas/ConflictExceptionResponseContent'
description: ConflictException 409 response
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsExceptionResponseContent'
description: TooManyRequestsException 429 response
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerExceptionResponseContent'
description: InternalServerException 500 response
tags:
- Destinations
components:
schemas:
EventDestinationsGetDestinationResponseContent:
description: Output containing the destination details.
properties:
concurrencyLimit:
description: The maximum number of concurrent deliveries for this destination. Contact Stedi to change your account limits.
minimum: 1
type: number
createdAt:
description: Creation timestamp for this destination.
format: date-time
type: string
description:
description: A description of the destination's purpose, such as "Receives transaction enrollment task notifications."
maxLength: 1024
type: string
destinationUrl:
description: The URL where Stedi delivers payloads through HTTP `POST`.
pattern: ^https://.+$
type: string
eventTypes:
description: The event types Stedi sends to this destination. Visit [event types](https://www.stedi.com/docs/healthcare/event-destinations-event-types) for a complete list.
items:
description: An event type identifier (e.g., enrollment.activated).
maxLength: 255
minLength: 1
type: string
minItems: 1
type: array
uniqueItems: true
id:
description: The unique identifier for the destination.
pattern: ^[a-z]{3,5}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
type: string
lastDeliveryTime:
description: The timestamp for Stedi's most recent delivery attempt to this destination. Absent when Stedi hasn't yet attempted a delivery.
format: date-time
type: string
name:
description: A human-readable name for the destination. Stedi displays this name in the portal.
maxLength: 255
minLength: 1
type: string
status:
$ref: '#/components/schemas/DestinationStatus'
description: The destination's current status. Stedi only sends event payloads to `ENABLED` destinations.
updatedAt:
description: Last update timestamp for this destination.
format: date-time
type: string
required:
- createdAt
- description
- destinationUrl
- eventTypes
- id
- name
- status
- updatedAt
type: object
AuthenticationFailedExceptionResponseContent:
description: The request credentials are missing or not valid.
properties:
me
# --- truncated at 32 KB (49 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/stedi/refs/heads/main/openapi/stedi-destinations-api-openapi.yml