API docs by Redocly

Svix Integration API (1.0.0)

Download OpenAPI specification:Download

URL: https://repzo.com

API for managing Svix webhook integrations

Svix Integration

Operations related to Svix webhook integration management

Get all Svix integration records

Retrieve a list of all Svix integration records with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
limit
integer [ 1 .. 100 ]
Default: 50

Maximum number of records to return

offset
integer >= 0
Default: 0

Number of records to skip for pagination

sort
string

Field to sort by

order
string
Default: "desc"
Enum: "asc" "desc"

Sort order (asc or desc)

filter
string

Filter conditions in JSON format

search
string

Search term for text fields

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "total": 0
}

Create a new Svix integration

Create a new Svix integration with the provided data

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Name of the integration

description
string

Description of the integration

applicationId
required
string

Svix application ID

endpointUrl
required
string <uri>

Webhook endpoint URL

eventTypes
Array of strings

List of event types to subscribe to

secret
string

Webhook secret for signature verification

isActive
boolean
Default: true

Whether the integration is active

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "name": "Webhook Integration",
  • "description": "string",
  • "applicationId": "app_12345",
  • "endpointUrl": "https://example.com/webhook",
  • "eventTypes": [
    ],
  • "secret": "string",
  • "isActive": true,
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get Svix integration by ID

Retrieve a specific Svix integration by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Svix integration ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update Svix integration

Update an existing Svix integration with new data

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Svix integration ID

Request Body schema: application/json
name
required
string

Name of the integration

description
string

Description of the integration

applicationId
required
string

Svix application ID

endpointUrl
required
string <uri>

Webhook endpoint URL

eventTypes
Array of strings

List of event types to subscribe to

secret
string

Webhook secret for signature verification

isActive
boolean
Default: true

Whether the integration is active

object

Additional metadata

Responses

Request samples

Content type
application/json
{
  • "name": "Webhook Integration",
  • "description": "string",
  • "applicationId": "app_12345",
  • "endpointUrl": "https://example.com/webhook",
  • "eventTypes": [
    ],
  • "secret": "string",
  • "isActive": true,
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete Svix integration

Delete an existing Svix integration

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Svix integration ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Svix integration deleted successfully"
}