/svix-ingest | Type: Application | PCID required: Yes
Tools
svix_ingest_v1_ingest_dashboard
Ingest Source Consumer Portal Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
source_id | string | Yes | — | The Source’s ID or UID. |
idempotency-key | string | No | — | The request’s idempotency key |
expiry | integer | No | — | How long the token will be valid for, in seconds. Valid values are between 1 hour and 7 days. The default is 7 days. |
readOnly | boolean | No | — | Whether the app portal should be in read-only mode. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"source_id": {
"type": "string",
"description": "The Source's ID or UID."
},
"idempotency-key": {
"type": "string",
"description": "The request's idempotency key"
},
"expiry": {
"type": "integer",
"description": "How long the token will be valid for, in seconds. Valid values are between 1 hour and 7 days. The default is 7 days."
},
"readOnly": {
"type": "boolean",
"description": "Whether the app portal should be in read-only mode."
}
},
"required": [
"PCID",
"source_id"
]
}
svix_ingest_v1_ingest_endpoint_create
Create Ingest Endpoint Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
source_id | string | Yes | — | The Source’s ID or UID. |
idempotency-key | string | No | — | The request’s idempotency key |
description | string | No | — | The description value |
disabled | boolean | No | — | The disabled value |
metadata | object | No | — | The metadata value |
rateLimit | integer | No | — | Rate Limit |
secret | string | No | — | The endpoint’s verification secret. Format: base64 encoded random bytes optionally prefixed with whsec_. It is recommended to not set this and let the server generate the secret. |
uid | string | No | — | Optional unique identifier for the endpoint. |
url | string | Yes | — | The url value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"source_id": {
"type": "string",
"description": "The Source's ID or UID."
},
"idempotency-key": {
"type": "string",
"description": "The request's idempotency key"
},
"description": {
"type": "string",
"description": "The description value"
},
"disabled": {
"type": "boolean",
"description": "The disabled value"
},
"metadata": {
"type": "object",
"description": "The metadata value"
},
"rateLimit": {
"type": "integer",
"description": "Rate Limit"
},
"secret": {
"type": "string",
"description": "The endpoint's verification secret. Format: `base64` encoded random bytes optionally prefixed with `whsec_`. It is recommended to not set this and let the server generate the secret."
},
"uid": {
"type": "string",
"description": "Optional unique identifier for the endpoint."
},
"url": {
"type": "string",
"description": "The url value"
}
},
"required": [
"PCID",
"source_id",
"url"
]
}
svix_ingest_v1_ingest_endpoint_delete
Delete Ingest Endpoint Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
source_id | string | Yes | — | The Source’s ID or UID. |
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"source_id": {
"type": "string",
"description": "The Source's ID or UID."
},
"endpoint_id": {
"type": "string",
"description": "The Endpoint's ID or UID."
}
},
"required": [
"PCID",
"source_id",
"endpoint_id"
]
}
svix_ingest_v1_ingest_endpoint_get
Get Ingest Endpoint Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
source_id | string | Yes | — | The Source’s ID or UID. |
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"source_id": {
"type": "string",
"description": "The Source's ID or UID."
},
"endpoint_id": {
"type": "string",
"description": "The Endpoint's ID or UID."
}
},
"required": [
"PCID",
"source_id",
"endpoint_id"
]
}
svix_ingest_v1_ingest_endpoint_get_headers
Get Ingest Endpoint Headers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
source_id | string | Yes | — | The Source’s ID or UID. |
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"source_id": {
"type": "string",
"description": "The Source's ID or UID."
},
"endpoint_id": {
"type": "string",
"description": "The Endpoint's ID or UID."
}
},
"required": [
"PCID",
"source_id",
"endpoint_id"
]
}
svix_ingest_v1_ingest_endpoint_get_secret
Get Ingest Endpoint Secret Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
source_id | string | Yes | — | The Source’s ID or UID. |
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"source_id": {
"type": "string",
"description": "The Source's ID or UID."
},
"endpoint_id": {
"type": "string",
"description": "The Endpoint's ID or UID."
}
},
"required": [
"PCID",
"source_id",
"endpoint_id"
]
}
svix_ingest_v1_ingest_endpoint_get_transformation
Get Ingest Endpoint Transformation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
source_id | string | Yes | — | The Source’s ID or UID. |
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"source_id": {
"type": "string",
"description": "The Source's ID or UID."
},
"endpoint_id": {
"type": "string",
"description": "The Endpoint's ID or UID."
}
},
"required": [
"PCID",
"source_id",
"endpoint_id"
]
}
svix_ingest_v1_ingest_endpoint_list
List Ingest Endpoints Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
source_id | string | Yes | — | The Source’s ID or UID. |
limit | integer | No | — | Limit the number of returned items |
iterator | string | No | — | The iterator returned from a prior invocation |
order | string | No | — | The sorting order of the returned items |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"source_id": {
"type": "string",
"description": "The Source's ID or UID."
},
"limit": {
"type": "integer",
"description": "Limit the number of returned items"
},
"iterator": {
"type": "string",
"description": "The iterator returned from a prior invocation"
},
"order": {
"type": "string",
"description": "The sorting order of the returned items",
"enum": [
"ascending",
"descending"
]
}
},
"required": [
"PCID",
"source_id"
]
}
svix_ingest_v1_ingest_endpoint_rotate_secret
Rotate Ingest Endpoint Secret Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
source_id | string | Yes | — | The Source’s ID or UID. |
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
idempotency-key | string | No | — | The request’s idempotency key |
key | string | No | — | The endpoint’s verification secret. Format: base64 encoded random bytes optionally prefixed with whsec_. It is recommended to not set this and let the server generate the secret. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"source_id": {
"type": "string",
"description": "The Source's ID or UID."
},
"endpoint_id": {
"type": "string",
"description": "The Endpoint's ID or UID."
},
"idempotency-key": {
"type": "string",
"description": "The request's idempotency key"
},
"key": {
"type": "string",
"description": "The endpoint's verification secret. Format: `base64` encoded random bytes optionally prefixed with `whsec_`. It is recommended to not set this and let the server generate the secret."
}
},
"required": [
"PCID",
"source_id",
"endpoint_id"
]
}
svix_ingest_v1_ingest_endpoint_set_transformation
Patch Ingest Endpoint Transformation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
source_id | string | Yes | — | The Source’s ID or UID. |
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
code | string | No | — | The code value |
enabled | boolean | No | — | The enabled value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"source_id": {
"type": "string",
"description": "The Source's ID or UID."
},
"endpoint_id": {
"type": "string",
"description": "The Endpoint's ID or UID."
},
"code": {
"type": "string",
"description": "The code value"
},
"enabled": {
"type": "boolean",
"description": "The enabled value"
}
},
"required": [
"PCID",
"source_id",
"endpoint_id"
]
}
svix_ingest_v1_ingest_endpoint_update
Update Ingest Endpoint Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
source_id | string | Yes | — | The Source’s ID or UID. |
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
description | string | No | — | The description value |
disabled | boolean | No | — | The disabled value |
metadata | object | No | — | The metadata value |
rateLimit | integer | No | — | Rate Limit |
uid | string | No | — | Optional unique identifier for the endpoint. |
url | string | Yes | — | The url value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"source_id": {
"type": "string",
"description": "The Source's ID or UID."
},
"endpoint_id": {
"type": "string",
"description": "The Endpoint's ID or UID."
},
"description": {
"type": "string",
"description": "The description value"
},
"disabled": {
"type": "boolean",
"description": "The disabled value"
},
"metadata": {
"type": "object",
"description": "The metadata value"
},
"rateLimit": {
"type": "integer",
"description": "Rate Limit"
},
"uid": {
"type": "string",
"description": "Optional unique identifier for the endpoint."
},
"url": {
"type": "string",
"description": "The url value"
}
},
"required": [
"PCID",
"source_id",
"endpoint_id",
"url"
]
}
svix_ingest_v1_ingest_endpoint_update_headers
Update Ingest Endpoint Headers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
source_id | string | Yes | — | The Source’s ID or UID. |
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
headers | object | Yes | — | The headers value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"source_id": {
"type": "string",
"description": "The Source's ID or UID."
},
"endpoint_id": {
"type": "string",
"description": "The Endpoint's ID or UID."
},
"headers": {
"type": "object",
"description": "The headers value"
}
},
"required": [
"PCID",
"source_id",
"endpoint_id",
"headers"
]
}
svix_ingest_v1_ingest_source_create
Create Ingest Source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idempotency-key | string | No | — | The request’s idempotency key |
metadata | object | No | — | The metadata value |
name | string | Yes | — | The name value |
uid | string | No | — | The Source’s UID. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"idempotency-key": {
"type": "string",
"description": "The request's idempotency key"
},
"metadata": {
"type": "object",
"description": "The metadata value"
},
"name": {
"type": "string",
"description": "The name value"
},
"uid": {
"type": "string",
"description": "The Source's UID."
}
},
"required": [
"PCID",
"name"
]
}
svix_ingest_v1_ingest_source_delete
Delete Ingest Source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
source_id | string | Yes | — | The Source’s ID or UID. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"source_id": {
"type": "string",
"description": "The Source's ID or UID."
}
},
"required": [
"PCID",
"source_id"
]
}
svix_ingest_v1_ingest_source_get
Get Ingest Source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
source_id | string | Yes | — | The Source’s ID or UID. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"source_id": {
"type": "string",
"description": "The Source's ID or UID."
}
},
"required": [
"PCID",
"source_id"
]
}
svix_ingest_v1_ingest_source_list
List Ingest Sources Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Limit the number of returned items |
iterator | string | No | — | The iterator returned from a prior invocation |
order | string | No | — | The sorting order of the returned items |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"limit": {
"type": "integer",
"description": "Limit the number of returned items"
},
"iterator": {
"type": "string",
"description": "The iterator returned from a prior invocation"
},
"order": {
"type": "string",
"description": "The sorting order of the returned items",
"enum": [
"ascending",
"descending"
]
}
},
"required": [
"PCID"
]
}
svix_ingest_v1_ingest_source_rotate_token
Rotate Ingest Token Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
source_id | string | Yes | — | The Source’s ID or UID. |
idempotency-key | string | No | — | The request’s idempotency key |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"source_id": {
"type": "string",
"description": "The Source's ID or UID."
},
"idempotency-key": {
"type": "string",
"description": "The request's idempotency key"
}
},
"required": [
"PCID",
"source_id"
]
}
svix_ingest_v1_ingest_source_update
Update Source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
source_id | string | Yes | — | The Source’s ID or UID. |
metadata | object | No | — | The metadata value |
name | string | Yes | — | The name value |
uid | string | No | — | The Source’s UID. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"source_id": {
"type": "string",
"description": "The Source's ID or UID."
},
"metadata": {
"type": "object",
"description": "The metadata value"
},
"name": {
"type": "string",
"description": "The name value"
},
"uid": {
"type": "string",
"description": "The Source's UID."
}
},
"required": [
"PCID",
"source_id",
"name"
]
}