Svix
App · 20 actions
Send webhooks and manage applications, endpoints, event types, and deliveries.
Actions
| Action | What it does |
|---|---|
| Archive an event type | Archive an event type. |
| Create an application | Create an application. |
| Create an endpoint | Create an endpoint. |
| Create an event type | Create an event type. |
| Delete an application | Delete an application. |
| Delete an endpoint | Delete an endpoint. |
| Get a webhook message | Get a webhook message. |
| Get an application | Get an application. |
| Get an endpoint | Get an endpoint. |
| Get an event type | Get an event type. |
| List applications | List applications. |
| List attempts for a message | List attempts for a message. |
| List attempts for an endpoint | List attempts for an endpoint. |
| List endpoints | List endpoints. |
| List event types | List event types. |
| List webhook messages | List webhook messages. |
| Send a webhook message | Send a webhook message. |
| Update an application | Update an application. |
| Update an endpoint | Update an endpoint. |
| Update an event type | Update an event type. |
Archive an event type
Archive an event type.
Inputs
- Event type name
event_type_nametextRequired - The event type's name.
- Expunge
expungetrue/false - By default event types are archived when "deleted". Passing this to `true` deletes them entirely.
Outputs
dataobject- The response from Svix.
Example output
{
"data": {}
}Create an application
Create an application.
Inputs
- Get if exists
get_if_existstrue/false - Get an existing application, or create a new one if doesn't exist. It's two separate functions in the libs.
- Idempotency key
idempotency_keytext - The request's idempotency key.
- Metadata
metadataobject - Metadata.
- Name
nametextRequired - Application name for human consumption.
- Throttle rate
throttle_ratenumber - Maximum messages per second to send to this application. Outgoing messages will be throttled to this rate.From 1 to 65535.
- Uid
uidtext - Optional unique identifier for the application.
Outputs
dataobject- The response from Svix.
Example output
{
"data": {
"createdAt": "example",
"id": "example",
"metadata": {},
"name": "example",
"throttleRate": 1,
"uid": "example",
"updatedAt": "example"
}
}Create an endpoint
Create an endpoint.
Inputs
- App
app_idtextRequired - The Application's ID or UID.
- Idempotency key
idempotency_keytext - The request's idempotency key.
- Channels
channelslist - List of message channels this endpoint listens to (omit for all).
- Description
descriptiontext - Description.
- Disabled
disabledtrue/false - Disabled.
- Event types
event_typeslist - Event types.
- Metadata
metadataobject - Metadata.
- Throttle rate
throttle_ratenumber - Maximum messages per second to send to this endpoint. Outgoing messages will be throttled to this rate.From 1 to 65535.
- Uid
uidtext - Optional unique identifier for the endpoint.
- URL
urltextRequired - Url.
Outputs
dataobject- The response from Svix.
Example output
{
"data": {
"channels": [
"example"
],
"createdAt": "example",
"description": "example",
"disabled": true,
"eventTypes": [
"example"
],
"expiry": "example",
"id": "example",
"metadata": {},
"throttleRate": 1,
"uid": "example",
"updatedAt": "example",
"url": "example"
}
}Create an event type
Create an event type.
Inputs
- Idempotency key
idempotency_keytext - The request's idempotency key.
- Archived
archivedtrue/false - Archived.
- Deprecated
deprecatedtrue/false - Deprecated.
- Description
descriptiontextRequired - Description.
- Description translations
description_translationsobject - Translated descriptions keyed by BCP 47 language tag.
- Feature flags
feature_flagslist - Feature flags.
- Group name
group_nametext - The event type group's name.
- Name
nametextRequired - The event type's name.
- Schemas
schemasobject - The schema for the event type for a specific version as a JSON schema.
Outputs
dataobject- The response from Svix.
Example output
{
"data": {
"archived": true,
"createdAt": "example",
"deprecated": true,
"description": "example",
"descriptionTranslations": {},
"featureFlag": "example",
"featureFlags": [
"example"
],
"groupName": "example",
"name": "example",
"schemas": {},
"updatedAt": "example"
}
}Delete an application
Delete an application.
Inputs
- App
app_idtextRequired - The Application's ID or UID.
Outputs
dataobject- The response from Svix.
Example output
{
"data": {}
}Delete an endpoint
Delete an endpoint.
Inputs
- App
app_idtextRequired - The Application's ID or UID.
- Endpoint
endpoint_idtextRequired - The Endpoint's ID or UID.
Outputs
dataobject- The response from Svix.
Example output
{
"data": {}
}Get a webhook message
Get a webhook message.
Inputs
- App
app_idtextRequired - The Application's ID or UID.
- Msg ID
msg_idtextRequired - The Message's ID or UID.
- With content
with_contenttrue/false - When `true` message payloads are included in the response. Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request without specifying this parameter.
Outputs
dataobject- The response from Svix.
Example output
{
"data": {
"channels": [
"example"
],
"deliverAt": "example",
"eventId": "example",
"eventType": "example",
"id": "example",
"payload": {},
"tags": [
"example"
],
"timestamp": "example"
}
}Get an application
Get an application.
Inputs
- App
app_idtextRequired - The Application's ID or UID.
Outputs
dataobject- The response from Svix.
Example output
{
"data": {
"createdAt": "example",
"id": "example",
"metadata": {},
"name": "example",
"throttleRate": 1,
"uid": "example",
"updatedAt": "example"
}
}Get an endpoint
Get an endpoint.
Inputs
- App
app_idtextRequired - The Application's ID or UID.
- Endpoint
endpoint_idtextRequired - The Endpoint's ID or UID.
Outputs
dataobject- The response from Svix.
Example output
{
"data": {
"channels": [
"example"
],
"createdAt": "example",
"description": "example",
"disabled": true,
"eventTypes": [
"example"
],
"expiry": "example",
"id": "example",
"metadata": {},
"throttleRate": 1,
"uid": "example",
"updatedAt": "example",
"url": "example"
}
}Get an event type
Get an event type.
Inputs
- Event type name
event_type_nametextRequired - The event type's name.
Outputs
dataobject- The response from Svix.
Example output
{
"data": {
"archived": true,
"createdAt": "example",
"deprecated": true,
"description": "example",
"descriptionTranslations": {},
"featureFlag": "example",
"featureFlags": [
"example"
],
"groupName": "example",
"name": "example",
"schemas": {},
"updatedAt": "example"
}
}List applications
List applications.
Inputs
- Exclude apps with no endpoints
exclude_apps_with_no_endpointstrue/false - Exclude applications that have no endpoints. Default is false.
- Exclude apps with disabled endpoints
exclude_apps_with_disabled_endpointstrue/false - Exclude applications that have only disabled endpoints. Default is false.
- Exclude apps with svix play endpoints
exclude_apps_with_svix_play_endpointstrue/false - Exclude applications that only have Svix Play endpoints. Default is false.
- Limit
limitnumber - Limit the number of returned items.From 1 to 250.
- Iterator
iteratortext - The iterator returned from a prior invocation.
- Order
ordertext - The sorting order of the returned items.One of:
ascending,descending.
Outputs
dataobject- The response from Svix.
Example output
{
"data": {
"data": [
{
"createdAt": "example",
"id": "example",
"metadata": {},
"name": "example",
"throttleRate": 1,
"uid": "example",
"updatedAt": "example"
}
],
"done": true,
"iterator": "example",
"prevIterator": "example"
}
}List attempts for a message
List attempts for a message.
Inputs
- Limit
limitnumber - Limit the number of returned items.From 1 to 250.
- Iterator
iteratortext - The iterator returned from a prior invocation.
- Status
statusnumber - Filter response based on the status of the attempt: Success (0), Pending (1), Failed (2), Sending (3), or Canceled (4).One of:
0,1,2,3,4. - Status code class
status_code_classnumber - Filter response based on the HTTP status code.One of:
0,100,200,300,400,500. - Channel
channeltext - Filter response based on the channel.
- Tag
tagtext - Filter response based on the tag.
- Endpoint
endpoint_idtext - Filter the attempts based on the attempted endpoint.
- Before
beforedate and time - Only include items created before a certain date.
- After
afterdate and time - Only include items created after a certain date.
- With content
with_contenttrue/false - When `true` attempt content is included in the response. Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request without specifying this parameter.
- Expanded statuses
expanded_statusestrue/false - When `true`, return the Canceled (4) status in attempts. If `false`, canceled attempts are returned as Success (0) for backwards compatibility.
- App
app_idtextRequired - The Application's ID or UID.
- Msg ID
msg_idtextRequired - The Message's ID or UID.
- Event types
event_typeslist - Filter response based on the event type.
Outputs
dataobject- The response from Svix.
Example output
{
"data": {
"data": [
{
"endpointId": "example",
"id": "example",
"msg": {
"channels": [
{}
],
"deliverAt": "example",
"eventId": "example",
"eventType": "example",
"id": "example",
"payload": {},
"tags": [
{}
],
"timestamp": "example"
},
"msgId": "example",
"response": "example",
"responseDurationMs": 1,
"responseStatusCode": 1,
"status": 0,
"statusText": "success",
"timestamp": "example",
"triggerType": 0,
"url": "example"
}
],
"done": true,
"iterator": "example",
"prevIterator": "example"
}
}List attempts for an endpoint
List attempts for an endpoint.
Inputs
- Limit
limitnumber - Limit the number of returned items.From 1 to 250.
- Iterator
iteratortext - The iterator returned from a prior invocation.
- Status
statusnumber - Filter response based on the status of the attempt: Success (0), Pending (1), Failed (2), Sending (3), or Canceled (4).One of:
0,1,2,3,4. - Status code class
status_code_classnumber - Filter response based on the HTTP status code.One of:
0,100,200,300,400,500. - Channel
channeltext - Filter response based on the channel.
- Tag
tagtext - Filter response based on the tag.
- Before
beforedate and time - Only include items created before a certain date.
- After
afterdate and time - Only include items created after a certain date.
- With content
with_contenttrue/false - When `true` attempt content is included in the response. Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request without specifying this parameter.
- With msg
with_msgtrue/false - When `true`, the message information is included in the response Note that message payloads are never included in the response, regardless of this flag.
- Expanded statuses
expanded_statusestrue/false - When `true`, return the Canceled (4) status in attempts. If `false`, canceled attempts are returned as Success (0) for backwards compatibility.
- Event types
event_typeslist - Filter response based on the event type.
- App
app_idtextRequired - The Application's ID or UID.
- Endpoint
endpoint_idtextRequired - The Endpoint's ID or UID.
Outputs
dataobject- The response from Svix.
Example output
{
"data": {
"data": [
{
"endpointId": "example",
"id": "example",
"msg": {
"channels": [
{}
],
"deliverAt": "example",
"eventId": "example",
"eventType": "example",
"id": "example",
"payload": {},
"tags": [
{}
],
"timestamp": "example"
},
"msgId": "example",
"response": "example",
"responseDurationMs": 1,
"responseStatusCode": 1,
"status": 0,
"statusText": "success",
"timestamp": "example",
"triggerType": 0,
"url": "example"
}
],
"done": true,
"iterator": "example",
"prevIterator": "example"
}
}List endpoints
List endpoints.
Inputs
- App
app_idtextRequired - The Application's ID or UID.
- Limit
limitnumber - Limit the number of returned items.From 1 to 250.
- Iterator
iteratortext - The iterator returned from a prior invocation.
- Order
ordertext - The sorting order of the returned items.One of:
ascending,descending.
Outputs
dataobject- The response from Svix.
Example output
{
"data": {
"data": [
{
"channels": [
"example"
],
"createdAt": "example",
"description": "example",
"disabled": true,
"eventTypes": [
"example"
],
"expiry": "example",
"id": "example",
"metadata": {},
"throttleRate": 1,
"uid": "example",
"updatedAt": "example",
"url": "example"
}
],
"done": true,
"iterator": "example",
"prevIterator": "example"
}
}List event types
List event types.
Inputs
- Limit
limitnumber - Limit the number of returned items.From 1 to 250.
- Iterator
iteratortext - The iterator returned from a prior invocation.
- Order
ordertext - The sorting order of the returned items.One of:
ascending,descending. - Include archived
include_archivedtrue/false - Include archived items in the response. Deprecated, use `archive_status` instead. Ignored when `archive_status` is set.
- Archive status
archive_statustext - Which items to include based on whether they are archived. Defaults to `active`.One of:
active,archived,all. - With content
with_contenttrue/false - When `true` the full item (including the schema) is included in the response.
Outputs
dataobject- The response from Svix.
Example output
{
"data": {
"data": [
{
"archived": true,
"createdAt": "example",
"deprecated": true,
"description": "example",
"descriptionTranslations": {},
"featureFlag": "example",
"featureFlags": [
"example"
],
"groupName": "example",
"name": "example",
"schemas": {},
"updatedAt": "example"
}
],
"done": true,
"iterator": "example",
"prevIterator": "example"
}
}List webhook messages
List webhook messages.
Inputs
- App
app_idtextRequired - The Application's ID or UID.
- Limit
limitnumber - Limit the number of returned items.From 1 to 250.
- Iterator
iteratortext - The iterator returned from a prior invocation.
- Channel
channeltext - Filter response based on the channel.
- Before
beforedate and time - Only include items created before a certain date.
- After
afterdate and time - Only include items created after a certain date.
- With content
with_contenttrue/false - When `true` message payloads are included in the response. Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request without specifying this parameter.
- Tag
tagtext - Filter messages matching the provided tag.
- Event types
event_typeslist - Filter response based on the event type.
Outputs
dataobject- The response from Svix.
Example output
{
"data": {
"data": [
{
"channels": [
"example"
],
"deliverAt": "example",
"eventId": "example",
"eventType": "example",
"id": "example",
"payload": {},
"tags": [
"example"
],
"timestamp": "example"
}
],
"done": true,
"iterator": "example",
"prevIterator": "example"
}
}Send a webhook message
Send a webhook message.
Inputs
- App
app_idtextRequired - The Application's ID or UID.
- With content
with_contenttrue/false - When `true`, message payloads are included in the response. Defaults to `false` in v2+ of the Svix SDKs, `true` in v1 or when manually making a request without specifying this parameter.
- Idempotency key
idempotency_keytext - The request's idempotency key.
- Channels
channelslist - List of free-form identifiers that endpoints can filter by.
- Deliver at
deliver_atdate and time - The date and time at which the message will be delivered. Note that this time is best-effort-only. Must be at least one minute and no more than 24 hours in the future.
- Event ID
event_idtext - Optional unique identifier for the message This should not contain the '.' character.
- Event type
event_typetextRequired - The event type's name.
- Payload
payloadobjectRequired - JSON payload to send as the request body of the webhook. We also support sending non-JSON payloads. Please contact us for more information. The serialized byte-length of this value should be under 1MiB. Please contact us if you need to send payloads large than 1MiB.
- Tags
tagslist - List of free-form tags that can be filtered by when listing messages.
Outputs
dataobject- The response from Svix.
Example output
{
"data": {
"channels": [
"example"
],
"deliverAt": "example",
"eventId": "example",
"eventType": "example",
"id": "example",
"payload": {},
"tags": [
"example"
],
"timestamp": "example"
}
}Update an application
Update an application.
Inputs
- App
app_idtextRequired - The Application's ID or UID.
- Metadata
metadataobject - Metadata.
- Name
nametext - Name.
- Throttle rate
throttle_ratenumber - Maximum messages per second to send to this application. Outgoing messages will be throttled to this rate.From 0 to 65535.
- Uid
uidtext - The Application's UID.
Outputs
dataobject- The response from Svix.
Example output
{
"data": {
"createdAt": "example",
"id": "example",
"metadata": {},
"name": "example",
"throttleRate": 1,
"uid": "example",
"updatedAt": "example"
}
}Update an endpoint
Update an endpoint.
Inputs
- App
app_idtextRequired - The Application's ID or UID.
- Endpoint
endpoint_idtextRequired - The Endpoint's ID or UID.
- Channels
channelslist - Channels.
- Description
descriptiontext - Description.
- Disabled
disabledtrue/false - Disabled.
- Event types
event_typeslist - Event types.
- Metadata
metadataobject - Metadata.
- Throttle rate
throttle_ratenumber - Maximum messages per second to send to this endpoint. Outgoing messages will be throttled to this rate.From 0 to 65535.
- Uid
uidtext - The Endpoint's UID.
- URL
urltext - Url.
Outputs
dataobject- The response from Svix.
Example output
{
"data": {
"channels": [
"example"
],
"createdAt": "example",
"description": "example",
"disabled": true,
"eventTypes": [
"example"
],
"expiry": "example",
"id": "example",
"metadata": {},
"throttleRate": 1,
"uid": "example",
"updatedAt": "example",
"url": "example"
}
}Update an event type
Update an event type.
Inputs
- Event type name
event_type_nametextRequired - The event type's name.
- Archived
archivedtrue/false - Archived.
- Deprecated
deprecatedtrue/false - Deprecated.
- Description
descriptiontext - Description.
- Description translations
description_translationsobject - Translated descriptions keyed by BCP 47 language tag.
- Feature flags
feature_flagslist - Feature flags.
- Group name
group_nametext - The event type group's name.
- Schemas
schemasobject - Schemas.
Outputs
dataobject- The response from Svix.
Example output
{
"data": {
"archived": true,
"createdAt": "example",
"deprecated": true,
"description": "example",
"descriptionTranslations": {},
"featureFlag": "example",
"featureFlags": [
"example"
],
"groupName": "example",
"name": "example",
"schemas": {},
"updatedAt": "example"
}
}