Svix Webhook API is one of 29 APIs that Svix publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Webhook. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
0 operations
across 0 paths,
and defines 39 schemas.
It is described by OpenAPI 3.2.0, at version 1.922.0.
Requests are made against 5 base URLs: https://api.eu.svix.com, https://api.us.svix.com, https://api.ca.svix.com, https://api.au.svix.com, https://api.in.svix.com.
The identity and technical contract details declared by the specification.
IngestMessageAttemptExhaustedEvent
object
Sent when a message delivery has failed (all of the retry attempts have been exhausted).
2 properties
2 required
IngestMessageAttemptExhaustedEventData
object
Sent when a message delivery has failed (all of the retry attempts have been exhausted) as a "ingest.message.attempt.exhausted" type, after it's failed four ti…
5 properties
4 required
MessageAttemptExhaustedEventData
object
Sent when a message delivery has failed (all of the retry attempts have been exhausted) as a "message.attempt.exhausted" type or after it's failed four times a…
6 properties
4 required
ApplicationStatsOut
object
3 properties
2 required
EndpointDeletedEventData
object
Sent when an endpoint is created, updated, or deleted
4 properties
2 required
MessageAttemptLogEvent
object
Sent after message attempts are made. Contains metadata about message attempts and their results. In order to reduce the frequency of webhooks, these are sent…
2 properties
2 required
MessageAttemptFailingEventData
object
Sent when a message delivery has failed (all of the retry attempts have been exhausted) as a "message.attempt.exhausted" type or after it's failed four times a…
6 properties
4 required
EndpointDisabledEvent
object
Sent when an endpoint has been automatically disabled after continuous failures, or manually via an API call.
2 properties
2 required
IngestMessageAttemptRecoveredEvent
object
Sent on a successful dispatch after an earlier failure op webhook has already been sent.
2 properties
2 required
IngestEndpointDisabledEvent
object
Sent when an ingest endpoint has been automatically disabled after continuous failures, or manually via an API call.
2 properties
2 required
MessageAttemptRecoveredEvent
object
Sent on a successful dispatch after an earlier failure op webhook has already been sent.
2 properties
2 required
MessageAttemptExhaustedEvent
object
Sent when a message delivery has failed (all of the retry attempts have been exhausted).
2 properties
2 required
EndpointUpdatedEventData
object
Sent when an endpoint is created, updated, or deleted
4 properties
2 required
ApplicationMessageIdPair
object
2 properties
2 required
EndpointDeletedEvent
object
Sent when an endpoint is deleted.
2 properties
2 required
BackgroundTaskStatus
string
EndpointUpdatedEvent
object
Sent when an endpoint is updated.
2 properties
2 required
EndpointEnabledEventData
object
Sent when an endpoint has been enabled.
4 properties
2 required
IngestEndpointDisabledEventData
object
Sent when an ingest endpoint has been automatically disabled after continuous failures, or manually via an API call.
5 properties
2 required
HttpAttemptTimes
object
2 properties
2 required
MessageStatus
integer
The sending status of the message: - Success = 0 - Pending = 1 - Fail = 2 - Sending = 3 - Canceled = 4
EndpointDisabledTrigger
string
BackgroundTaskFinishedEvent2
object
4 properties
4 required
BackgroundTaskType
string
EndpointEnabledEvent
object
Sent when an endpoint has been enabled.
2 properties
2 required
EndpointCreatedEventData
object
Sent when an endpoint is created, updated, or deleted
4 properties
2 required
MessageAttemptLog
object
15 properties
11 required
IngestMessageAttemptRecoveredEventData
object
Sent when a message delivery has failed (all of the retry attempts have been exhausted) as a "ingest.message.attempt.exhausted" type, after it's failed four ti…
5 properties
4 required
EndpointDisabledEventData
object
Sent when an endpoint has been automatically disabled after continuous failures, or manually via an API call.
6 properties
2 required
ApplicationMessageFailure
object
2 properties
2 required
IngestMessageAttemptFailingEvent
object
Sent after a message has been failing for a few times. It's sent on the fourth failure. It complements ingest.message.attempt.exhausted which is sent after the…
2 properties
2 required
MessageAttemptFailingEvent
object
Sent after a message has been failing for a few times. It's sent on the fourth failure. It complements message.attempt.exhausted which is sent after the last f…
2 properties
2 required
EndpointCreatedEvent
object
Sent when an endpoint is created.
2 properties
2 required
AggregatedEventTypes
object
3 properties
3 required
BackgroundTaskFinishedEvent
object
Sent when a background task is finished.
2 properties
2 required
MessageAttemptFailedData
object
3 properties
3 required
MessageAttemptRecoveredEventData
object
Sent when a message delivery has failed (all of the retry attempts have been exhausted) as a "message.attempt.exhausted" type or after it's failed four times a…
6 properties
4 required
IngestMessageAttemptFailingEventData
object
Sent when a message delivery has failed (all of the retry attempts have been exhausted) as a "ingest.message.attempt.exhausted" type, after it's failed four ti…
5 properties
4 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Svix publishes across the network.
