# Svix

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

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/svix

## Actions

### Archive an event type

Archive an event type.

**Inputs**

- Event type name (`event_type_name`, text, required): The event type's name.
- Expunge (`expunge`, true/false): By default event types are archived when "deleted". Passing this to `true` deletes them entirely.

**Outputs**

- `data` (object): The response from Svix.

**Example output**

```json
{
  "data": {}
}
```

### Create an application

Create an application.

**Inputs**

- Get if exists (`get_if_exists`, true/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_key`, text): The request's idempotency key.
- Metadata (`metadata`, object): Metadata.
- Name (`name`, text, required): Application name for human consumption.
- Throttle rate (`throttle_rate`, number): Maximum messages per second to send to this application. Outgoing messages will be throttled to this rate. From 1 to 65535.
- Uid (`uid`, text): Optional unique identifier for the application.

**Outputs**

- `data` (object): The response from Svix.

**Example output**

```json
{
  "data": {
    "createdAt": "example",
    "id": "example",
    "metadata": {},
    "name": "example",
    "throttleRate": 1,
    "uid": "example",
    "updatedAt": "example"
  }
}
```

### Create an endpoint

Create an endpoint.

**Inputs**

- App (`app_id`, text, required): The Application's ID or UID.
- Idempotency key (`idempotency_key`, text): The request's idempotency key.
- Channels (`channels`, list): List of message channels this endpoint listens to (omit for all).
- Description (`description`, text): Description.
- Disabled (`disabled`, true/false): Disabled.
- Event types (`event_types`, list): Event types.
- Metadata (`metadata`, object): Metadata.
- Throttle rate (`throttle_rate`, number): Maximum messages per second to send to this endpoint. Outgoing messages will be throttled to this rate. From 1 to 65535.
- Uid (`uid`, text): Optional unique identifier for the endpoint.
- URL (`url`, text, required): Url.

**Outputs**

- `data` (object): The response from Svix.

**Example output**

```json
{
  "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_key`, text): The request's idempotency key.
- Archived (`archived`, true/false): Archived.
- Deprecated (`deprecated`, true/false): Deprecated.
- Description (`description`, text, required): Description.
- Description translations (`description_translations`, object): Translated descriptions keyed by BCP 47 language tag.
- Feature flags (`feature_flags`, list): Feature flags.
- Group name (`group_name`, text): The event type group's name.
- Name (`name`, text, required): The event type's name.
- Schemas (`schemas`, object): The schema for the event type for a specific version as a JSON schema.

**Outputs**

- `data` (object): The response from Svix.

**Example output**

```json
{
  "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_id`, text, required): The Application's ID or UID.

**Outputs**

- `data` (object): The response from Svix.

**Example output**

```json
{
  "data": {}
}
```

### Delete an endpoint

Delete an endpoint.

**Inputs**

- App (`app_id`, text, required): The Application's ID or UID.
- Endpoint (`endpoint_id`, text, required): The Endpoint's ID or UID.

**Outputs**

- `data` (object): The response from Svix.

**Example output**

```json
{
  "data": {}
}
```

### Get a webhook message

Get a webhook message.

**Inputs**

- App (`app_id`, text, required): The Application's ID or UID.
- Msg ID (`msg_id`, text, required): The Message's ID or UID.
- With content (`with_content`, true/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**

- `data` (object): The response from Svix.

**Example output**

```json
{
  "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_id`, text, required): The Application's ID or UID.

**Outputs**

- `data` (object): The response from Svix.

**Example output**

```json
{
  "data": {
    "createdAt": "example",
    "id": "example",
    "metadata": {},
    "name": "example",
    "throttleRate": 1,
    "uid": "example",
    "updatedAt": "example"
  }
}
```

### Get an endpoint

Get an endpoint.

**Inputs**

- App (`app_id`, text, required): The Application's ID or UID.
- Endpoint (`endpoint_id`, text, required): The Endpoint's ID or UID.

**Outputs**

- `data` (object): The response from Svix.

**Example output**

```json
{
  "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_name`, text, required): The event type's name.

**Outputs**

- `data` (object): The response from Svix.

**Example output**

```json
{
  "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_endpoints`, true/false): Exclude applications that have no endpoints. Default is false.
- Exclude apps with disabled endpoints (`exclude_apps_with_disabled_endpoints`, true/false): Exclude applications that have only disabled endpoints. Default is false.
- Exclude apps with svix play endpoints (`exclude_apps_with_svix_play_endpoints`, true/false): Exclude applications that only have Svix Play endpoints. Default is false.
- Limit (`limit`, number): Limit the number of returned items. From 1 to 250.
- Iterator (`iterator`, text): The iterator returned from a prior invocation.
- Order (`order`, text): The sorting order of the returned items. One of: `ascending`, `descending`.

**Outputs**

- `data` (object): The response from Svix.

**Example output**

```json
{
  "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 (`limit`, number): Limit the number of returned items. From 1 to 250.
- Iterator (`iterator`, text): The iterator returned from a prior invocation.
- Status (`status`, number): 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_class`, number): Filter response based on the HTTP status code. One of: `0`, `100`, `200`, `300`, `400`, `500`.
- Channel (`channel`, text): Filter response based on the channel.
- Tag (`tag`, text): Filter response based on the tag.
- Endpoint (`endpoint_id`, text): Filter the attempts based on the attempted endpoint.
- Before (`before`, date and time): Only include items created before a certain date.
- After (`after`, date and time): Only include items created after a certain date.
- With content (`with_content`, true/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_statuses`, true/false): When `true`, return the Canceled (4) status in attempts. If `false`, canceled attempts are returned as Success (0) for backwards compatibility.
- App (`app_id`, text, required): The Application's ID or UID.
- Msg ID (`msg_id`, text, required): The Message's ID or UID.
- Event types (`event_types`, list): Filter response based on the event type.

**Outputs**

- `data` (object): The response from Svix.

**Example output**

```json
{
  "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 (`limit`, number): Limit the number of returned items. From 1 to 250.
- Iterator (`iterator`, text): The iterator returned from a prior invocation.
- Status (`status`, number): 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_class`, number): Filter response based on the HTTP status code. One of: `0`, `100`, `200`, `300`, `400`, `500`.
- Channel (`channel`, text): Filter response based on the channel.
- Tag (`tag`, text): Filter response based on the tag.
- Before (`before`, date and time): Only include items created before a certain date.
- After (`after`, date and time): Only include items created after a certain date.
- With content (`with_content`, true/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_msg`, true/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_statuses`, true/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_types`, list): Filter response based on the event type.
- App (`app_id`, text, required): The Application's ID or UID.
- Endpoint (`endpoint_id`, text, required): The Endpoint's ID or UID.

**Outputs**

- `data` (object): The response from Svix.

**Example output**

```json
{
  "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_id`, text, required): The Application's ID or UID.
- Limit (`limit`, number): Limit the number of returned items. From 1 to 250.
- Iterator (`iterator`, text): The iterator returned from a prior invocation.
- Order (`order`, text): The sorting order of the returned items. One of: `ascending`, `descending`.

**Outputs**

- `data` (object): The response from Svix.

**Example output**

```json
{
  "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 (`limit`, number): Limit the number of returned items. From 1 to 250.
- Iterator (`iterator`, text): The iterator returned from a prior invocation.
- Order (`order`, text): The sorting order of the returned items. One of: `ascending`, `descending`.
- Include archived (`include_archived`, true/false): Include archived items in the response. Deprecated, use `archive_status` instead. Ignored when `archive_status` is set.
- Archive status (`archive_status`, text): Which items to include based on whether they are archived. Defaults to `active`. One of: `active`, `archived`, `all`.
- With content (`with_content`, true/false): When `true` the full item (including the schema) is included in the response.

**Outputs**

- `data` (object): The response from Svix.

**Example output**

```json
{
  "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_id`, text, required): The Application's ID or UID.
- Limit (`limit`, number): Limit the number of returned items. From 1 to 250.
- Iterator (`iterator`, text): The iterator returned from a prior invocation.
- Channel (`channel`, text): Filter response based on the channel.
- Before (`before`, date and time): Only include items created before a certain date.
- After (`after`, date and time): Only include items created after a certain date.
- With content (`with_content`, true/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 (`tag`, text): Filter messages matching the provided tag.
- Event types (`event_types`, list): Filter response based on the event type.

**Outputs**

- `data` (object): The response from Svix.

**Example output**

```json
{
  "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_id`, text, required): The Application's ID or UID.
- With content (`with_content`, true/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_key`, text): The request's idempotency key.
- Channels (`channels`, list): List of free-form identifiers that endpoints can filter by.
- Deliver at (`deliver_at`, date 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_id`, text): Optional unique identifier for the message This should not contain the '.' character.
- Event type (`event_type`, text, required): The event type's name.
- Payload (`payload`, object, required): 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 (`tags`, list): List of free-form tags that can be filtered by when listing messages.

**Outputs**

- `data` (object): The response from Svix.

**Example output**

```json
{
  "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_id`, text, required): The Application's ID or UID.
- Metadata (`metadata`, object): Metadata.
- Name (`name`, text): Name.
- Throttle rate (`throttle_rate`, number): Maximum messages per second to send to this application. Outgoing messages will be throttled to this rate. From 0 to 65535.
- Uid (`uid`, text): The Application's UID.

**Outputs**

- `data` (object): The response from Svix.

**Example output**

```json
{
  "data": {
    "createdAt": "example",
    "id": "example",
    "metadata": {},
    "name": "example",
    "throttleRate": 1,
    "uid": "example",
    "updatedAt": "example"
  }
}
```

### Update an endpoint

Update an endpoint.

**Inputs**

- App (`app_id`, text, required): The Application's ID or UID.
- Endpoint (`endpoint_id`, text, required): The Endpoint's ID or UID.
- Channels (`channels`, list): Channels.
- Description (`description`, text): Description.
- Disabled (`disabled`, true/false): Disabled.
- Event types (`event_types`, list): Event types.
- Metadata (`metadata`, object): Metadata.
- Throttle rate (`throttle_rate`, number): Maximum messages per second to send to this endpoint. Outgoing messages will be throttled to this rate. From 0 to 65535.
- Uid (`uid`, text): The Endpoint's UID.
- URL (`url`, text): Url.

**Outputs**

- `data` (object): The response from Svix.

**Example output**

```json
{
  "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_name`, text, required): The event type's name.
- Archived (`archived`, true/false): Archived.
- Deprecated (`deprecated`, true/false): Deprecated.
- Description (`description`, text): Description.
- Description translations (`description_translations`, object): Translated descriptions keyed by BCP 47 language tag.
- Feature flags (`feature_flags`, list): Feature flags.
- Group name (`group_name`, text): The event type group's name.
- Schemas (`schemas`, object): Schemas.

**Outputs**

- `data` (object): The response from Svix.

**Example output**

```json
{
  "data": {
    "archived": true,
    "createdAt": "example",
    "deprecated": true,
    "description": "example",
    "descriptionTranslations": {},
    "featureFlag": "example",
    "featureFlags": [
      "example"
    ],
    "groupName": "example",
    "name": "example",
    "schemas": {},
    "updatedAt": "example"
  }
}
```
