Skip to main content
Server path: /svix-ingest | Type: Application | PCID required: Yes

Tools


svix_ingest_v1_ingest_dashboard

Ingest Source Consumer Portal Parameters:
ParameterTypeRequiredDefaultDescription
source_idstringYesThe Source’s ID or UID.
expiryintegerNoHow long the token will be valid for, in seconds. Valid values are between 1 hour and 7 days. The default is 7 days.
readOnlybooleanNoWhether the app portal should be in read-only mode.

svix_ingest_v1_ingest_endpoint_create

Create Ingest Endpoint Parameters:
ParameterTypeRequiredDefaultDescription
source_idstringYesThe Source’s ID or UID.
descriptionstringNoThe description value
disabledbooleanNoThe disabled value
metadataobjectNoThe metadata value
rateLimitintegerNoRate Limit
secretstringNoThe 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.
uidstringNoOptional unique identifier for the endpoint.
urlstringYesThe url value

svix_ingest_v1_ingest_endpoint_delete

Delete Ingest Endpoint Parameters:
ParameterTypeRequiredDefaultDescription
source_idstringYesThe Source’s ID or UID.
endpoint_idstringYesThe Endpoint’s ID or UID.

svix_ingest_v1_ingest_endpoint_get

Get Ingest Endpoint Parameters:
ParameterTypeRequiredDefaultDescription
source_idstringYesThe Source’s ID or UID.
endpoint_idstringYesThe Endpoint’s ID or UID.

svix_ingest_v1_ingest_endpoint_get_headers

Get Ingest Endpoint Headers Parameters:
ParameterTypeRequiredDefaultDescription
source_idstringYesThe Source’s ID or UID.
endpoint_idstringYesThe Endpoint’s ID or UID.

svix_ingest_v1_ingest_endpoint_get_secret

Get Ingest Endpoint Secret Parameters:
ParameterTypeRequiredDefaultDescription
source_idstringYesThe Source’s ID or UID.
endpoint_idstringYesThe Endpoint’s ID or UID.

svix_ingest_v1_ingest_endpoint_get_transformation

Get Ingest Endpoint Transformation Parameters:
ParameterTypeRequiredDefaultDescription
source_idstringYesThe Source’s ID or UID.
endpoint_idstringYesThe Endpoint’s ID or UID.

svix_ingest_v1_ingest_endpoint_list

List Ingest Endpoints Parameters:
ParameterTypeRequiredDefaultDescription
source_idstringYesThe Source’s ID or UID.
limitintegerNoLimit the number of returned items
iteratorstringNoThe iterator returned from a prior invocation
orderstringNoThe sorting order of the returned items

svix_ingest_v1_ingest_endpoint_rotate_secret

Rotate Ingest Endpoint Secret Parameters:
ParameterTypeRequiredDefaultDescription
source_idstringYesThe Source’s ID or UID.
endpoint_idstringYesThe Endpoint’s ID or UID.
keystringNoThe 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.

svix_ingest_v1_ingest_endpoint_set_transformation

Patch Ingest Endpoint Transformation Parameters:
ParameterTypeRequiredDefaultDescription
source_idstringYesThe Source’s ID or UID.
endpoint_idstringYesThe Endpoint’s ID or UID.
codestringNoThe code value
enabledbooleanNoThe enabled value

svix_ingest_v1_ingest_endpoint_update

Update Ingest Endpoint Parameters:
ParameterTypeRequiredDefaultDescription
source_idstringYesThe Source’s ID or UID.
endpoint_idstringYesThe Endpoint’s ID or UID.
descriptionstringNoThe description value
disabledbooleanNoThe disabled value
metadataobjectNoThe metadata value
rateLimitintegerNoRate Limit
uidstringNoOptional unique identifier for the endpoint.
urlstringYesThe url value

svix_ingest_v1_ingest_endpoint_update_headers

Update Ingest Endpoint Headers Parameters:
ParameterTypeRequiredDefaultDescription
source_idstringYesThe Source’s ID or UID.
endpoint_idstringYesThe Endpoint’s ID or UID.
headersobjectYesThe headers value

svix_ingest_v1_ingest_source_create

Create Ingest Source Parameters:
ParameterTypeRequiredDefaultDescription
metadataobjectNoThe metadata value
namestringYesThe name value
uidstringNoThe Source’s UID.

svix_ingest_v1_ingest_source_delete

Delete Ingest Source Parameters:
ParameterTypeRequiredDefaultDescription
source_idstringYesThe Source’s ID or UID.

svix_ingest_v1_ingest_source_get

Get Ingest Source Parameters:
ParameterTypeRequiredDefaultDescription
source_idstringYesThe Source’s ID or UID.

svix_ingest_v1_ingest_source_list

List Ingest Sources Parameters:
ParameterTypeRequiredDefaultDescription
limitintegerNoLimit the number of returned items
iteratorstringNoThe iterator returned from a prior invocation
orderstringNoThe sorting order of the returned items

svix_ingest_v1_ingest_source_rotate_token

Rotate Ingest Token Parameters:
ParameterTypeRequiredDefaultDescription
source_idstringYesThe Source’s ID or UID.

svix_ingest_v1_ingest_source_update

Update Source Parameters:
ParameterTypeRequiredDefaultDescription
source_idstringYesThe Source’s ID or UID.
metadataobjectNoThe metadata value
namestringYesThe name value
uidstringNoThe Source’s UID.