Svix

App · 20 actions

Send webhooks and manage applications, endpoints, event types, and deliveries.

Actions

ActionWhat it does
Archive an event typeArchive an event type.
Create an applicationCreate an application.
Create an endpointCreate an endpoint.
Create an event typeCreate an event type.
Delete an applicationDelete an application.
Delete an endpointDelete an endpoint.
Get a webhook messageGet a webhook message.
Get an applicationGet an application.
Get an endpointGet an endpoint.
Get an event typeGet an event type.
List applicationsList applications.
List attempts for a messageList attempts for a message.
List attempts for an endpointList attempts for an endpoint.
List endpointsList endpoints.
List event typesList event types.
List webhook messagesList webhook messages.
Send a webhook messageSend a webhook message.
Update an applicationUpdate an application.
Update an endpointUpdate an endpoint.
Update an event typeUpdate an event type.

Archive an event type

Archive an event type.

Inputs

Event type nameevent_type_nametextRequired
The event type's name.
Expungeexpungetrue/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 existsget_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 keyidempotency_keytext
The request's idempotency key.
Metadatametadataobject
Metadata.
NamenametextRequired
Application name for human consumption.
Throttle ratethrottle_ratenumber
Maximum messages per second to send to this application. Outgoing messages will be throttled to this rate.From 1 to 65535.
Uiduidtext
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

Appapp_idtextRequired
The Application's ID or UID.
Idempotency keyidempotency_keytext
The request's idempotency key.
Channelschannelslist
List of message channels this endpoint listens to (omit for all).
Descriptiondescriptiontext
Description.
Disableddisabledtrue/false
Disabled.
Event typesevent_typeslist
Event types.
Metadatametadataobject
Metadata.
Throttle ratethrottle_ratenumber
Maximum messages per second to send to this endpoint. Outgoing messages will be throttled to this rate.From 1 to 65535.
Uiduidtext
Optional unique identifier for the endpoint.
URLurltextRequired
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 keyidempotency_keytext
The request's idempotency key.
Archivedarchivedtrue/false
Archived.
Deprecateddeprecatedtrue/false
Deprecated.
DescriptiondescriptiontextRequired
Description.
Description translationsdescription_translationsobject
Translated descriptions keyed by BCP 47 language tag.
Feature flagsfeature_flagslist
Feature flags.
Group namegroup_nametext
The event type group's name.
NamenametextRequired
The event type's name.
Schemasschemasobject
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

Appapp_idtextRequired
The Application's ID or UID.

Outputs

dataobject
The response from Svix.
Example output
{
  "data": {}
}

Delete an endpoint

Delete an endpoint.

Inputs

Appapp_idtextRequired
The Application's ID or UID.
Endpointendpoint_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

Appapp_idtextRequired
The Application's ID or UID.
Msg IDmsg_idtextRequired
The Message's ID or UID.
With contentwith_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

Appapp_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

Appapp_idtextRequired
The Application's ID or UID.
Endpointendpoint_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 nameevent_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 endpointsexclude_apps_with_no_endpointstrue/false
Exclude applications that have no endpoints. Default is false.
Exclude apps with disabled endpointsexclude_apps_with_disabled_endpointstrue/false
Exclude applications that have only disabled endpoints. Default is false.
Exclude apps with svix play endpointsexclude_apps_with_svix_play_endpointstrue/false
Exclude applications that only have Svix Play endpoints. Default is false.
Limitlimitnumber
Limit the number of returned items.From 1 to 250.
Iteratoriteratortext
The iterator returned from a prior invocation.
Orderordertext
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

Limitlimitnumber
Limit the number of returned items.From 1 to 250.
Iteratoriteratortext
The iterator returned from a prior invocation.
Statusstatusnumber
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 classstatus_code_classnumber
Filter response based on the HTTP status code.One of: 0, 100, 200, 300, 400, 500.
Channelchanneltext
Filter response based on the channel.
Tagtagtext
Filter response based on the tag.
Endpointendpoint_idtext
Filter the attempts based on the attempted endpoint.
Beforebeforedate and time
Only include items created before a certain date.
Afterafterdate and time
Only include items created after a certain date.
With contentwith_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 statusesexpanded_statusestrue/false
When `true`, return the Canceled (4) status in attempts. If `false`, canceled attempts are returned as Success (0) for backwards compatibility.
Appapp_idtextRequired
The Application's ID or UID.
Msg IDmsg_idtextRequired
The Message's ID or UID.
Event typesevent_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

Limitlimitnumber
Limit the number of returned items.From 1 to 250.
Iteratoriteratortext
The iterator returned from a prior invocation.
Statusstatusnumber
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 classstatus_code_classnumber
Filter response based on the HTTP status code.One of: 0, 100, 200, 300, 400, 500.
Channelchanneltext
Filter response based on the channel.
Tagtagtext
Filter response based on the tag.
Beforebeforedate and time
Only include items created before a certain date.
Afterafterdate and time
Only include items created after a certain date.
With contentwith_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 msgwith_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 statusesexpanded_statusestrue/false
When `true`, return the Canceled (4) status in attempts. If `false`, canceled attempts are returned as Success (0) for backwards compatibility.
Event typesevent_typeslist
Filter response based on the event type.
Appapp_idtextRequired
The Application's ID or UID.
Endpointendpoint_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

Appapp_idtextRequired
The Application's ID or UID.
Limitlimitnumber
Limit the number of returned items.From 1 to 250.
Iteratoriteratortext
The iterator returned from a prior invocation.
Orderordertext
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

Limitlimitnumber
Limit the number of returned items.From 1 to 250.
Iteratoriteratortext
The iterator returned from a prior invocation.
Orderordertext
The sorting order of the returned items.One of: ascending, descending.
Include archivedinclude_archivedtrue/false
Include archived items in the response. Deprecated, use `archive_status` instead. Ignored when `archive_status` is set.
Archive statusarchive_statustext
Which items to include based on whether they are archived. Defaults to `active`.One of: active, archived, all.
With contentwith_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

Appapp_idtextRequired
The Application's ID or UID.
Limitlimitnumber
Limit the number of returned items.From 1 to 250.
Iteratoriteratortext
The iterator returned from a prior invocation.
Channelchanneltext
Filter response based on the channel.
Beforebeforedate and time
Only include items created before a certain date.
Afterafterdate and time
Only include items created after a certain date.
With contentwith_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.
Tagtagtext
Filter messages matching the provided tag.
Event typesevent_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

Appapp_idtextRequired
The Application's ID or UID.
With contentwith_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 keyidempotency_keytext
The request's idempotency key.
Channelschannelslist
List of free-form identifiers that endpoints can filter by.
Deliver atdeliver_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 IDevent_idtext
Optional unique identifier for the message This should not contain the '.' character.
Event typeevent_typetextRequired
The event type's name.
PayloadpayloadobjectRequired
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.
Tagstagslist
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

Appapp_idtextRequired
The Application's ID or UID.
Metadatametadataobject
Metadata.
Namenametext
Name.
Throttle ratethrottle_ratenumber
Maximum messages per second to send to this application. Outgoing messages will be throttled to this rate.From 0 to 65535.
Uiduidtext
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

Appapp_idtextRequired
The Application's ID or UID.
Endpointendpoint_idtextRequired
The Endpoint's ID or UID.
Channelschannelslist
Channels.
Descriptiondescriptiontext
Description.
Disableddisabledtrue/false
Disabled.
Event typesevent_typeslist
Event types.
Metadatametadataobject
Metadata.
Throttle ratethrottle_ratenumber
Maximum messages per second to send to this endpoint. Outgoing messages will be throttled to this rate.From 0 to 65535.
Uiduidtext
The Endpoint's UID.
URLurltext
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 nameevent_type_nametextRequired
The event type's name.
Archivedarchivedtrue/false
Archived.
Deprecateddeprecatedtrue/false
Deprecated.
Descriptiondescriptiontext
Description.
Description translationsdescription_translationsobject
Translated descriptions keyed by BCP 47 language tag.
Feature flagsfeature_flagslist
Feature flags.
Group namegroup_nametext
The event type group's name.
Schemasschemasobject
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"
  }
}

On this page