/svix-applications | Type: Application | PCID required: Yes
Tools
svix_applications_v1_application_create
Create Application Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
get_if_exists | boolean | No | — | Get an existing application, or create a new one if doesn’t exist. It’s two separate functions in the libs. |
idempotency-key | string | No | — | The request’s idempotency key |
metadata | object | No | — | The metadata value |
name | string | Yes | — | Application name for human consumption. |
rateLimit | integer | No | — | Deprecated, use throttleRate instead. |
throttleRate | integer | No | — | Maximum messages per second to send to this application. Outgoing messages will be throttled to this rate. |
uid | string | No | — | Optional unique identifier for the application. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"get_if_exists": {
"type": "boolean",
"description": "Get an existing application, or create a new one if doesn't exist. It's two separate functions in the libs."
},
"idempotency-key": {
"type": "string",
"description": "The request's idempotency key"
},
"metadata": {
"type": "object",
"description": "The metadata value"
},
"name": {
"type": "string",
"description": "Application name for human consumption."
},
"rateLimit": {
"type": "integer",
"description": "Deprecated, use `throttleRate` instead."
},
"throttleRate": {
"type": "integer",
"description": "Maximum messages per second to send to this application. Outgoing messages will be throttled to this rate."
},
"uid": {
"type": "string",
"description": "Optional unique identifier for the application."
}
},
"required": [
"PCID",
"name"
]
}
svix_applications_v1_application_delete
Delete Application Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_id": {
"type": "string",
"description": "The Application's ID or UID."
}
},
"required": [
"PCID",
"app_id"
]
}
svix_applications_v1_application_get
Get Application Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_id": {
"type": "string",
"description": "The Application's ID or UID."
}
},
"required": [
"PCID",
"app_id"
]
}
svix_applications_v1_application_list
List Applications Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
exclude_apps_with_no_endpoints | boolean | No | — | Exclude applications that have no endpoints. Default is false. |
exclude_apps_with_disabled_endpoints | boolean | No | — | Exclude applications that have only disabled endpoints. Default is false. |
exclude_apps_with_svix_play_endpoints | boolean | No | — | Exclude applications that only have Svix Play endpoints. Default is false. |
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"
},
"exclude_apps_with_no_endpoints": {
"type": "boolean",
"description": "Exclude applications that have no endpoints. Default is false."
},
"exclude_apps_with_disabled_endpoints": {
"type": "boolean",
"description": "Exclude applications that have only disabled endpoints. Default is false."
},
"exclude_apps_with_svix_play_endpoints": {
"type": "boolean",
"description": "Exclude applications that only have Svix Play endpoints. Default is false."
},
"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_applications_v1_application_patch
Patch Application Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
metadata | object | No | — | The metadata value |
name | string | No | — | The name value |
rateLimit | integer | No | — | Deprecated, use throttleRate instead. |
throttleRate | integer | No | — | Maximum messages per second to send to this application. Outgoing messages will be throttled to this rate. |
uid | string | No | — | The Application’s UID. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_id": {
"type": "string",
"description": "The Application's ID or UID."
},
"metadata": {
"type": "object",
"description": "The metadata value"
},
"name": {
"type": "string",
"description": "The name value"
},
"rateLimit": {
"type": "integer",
"description": "Deprecated, use `throttleRate` instead."
},
"throttleRate": {
"type": "integer",
"description": "Maximum messages per second to send to this application. Outgoing messages will be throttled to this rate."
},
"uid": {
"type": "string",
"description": "The Application's UID."
}
},
"required": [
"PCID",
"app_id"
]
}
svix_applications_v1_application_update
Update Application Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
metadata | object | No | — | The metadata value |
name | string | Yes | — | Application name for human consumption. |
rateLimit | integer | No | — | Deprecated, use throttleRate instead. |
throttleRate | integer | No | — | Maximum messages per second to send to this application. Outgoing messages will be throttled to this rate. |
uid | string | No | — | Optional unique identifier for the application. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_id": {
"type": "string",
"description": "The Application's ID or UID."
},
"metadata": {
"type": "object",
"description": "The metadata value"
},
"name": {
"type": "string",
"description": "Application name for human consumption."
},
"rateLimit": {
"type": "integer",
"description": "Deprecated, use `throttleRate` instead."
},
"throttleRate": {
"type": "integer",
"description": "Maximum messages per second to send to this application. Outgoing messages will be throttled to this rate."
},
"uid": {
"type": "string",
"description": "Optional unique identifier for the application."
}
},
"required": [
"PCID",
"app_id",
"name"
]
}
svix_applications_v1_authentication_app_portal_access
Get Consumer App Portal Access Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
idempotency-key | string | No | — | The request’s idempotency key |
application | object | No | — | The application value |
capabilities | string[] | No | — | Custom capabilities attached to the token, You can combine as many capabilities as necessary. The ViewBase capability is always required - ViewBase: Basic read only permissions, does not allow the user to see the endpoint secret. - ViewEndpointSecret: Allows user to view the endpoint secret. - ManageEndpointSecret: Allows user to rotate and view the endpoint secret. - ManageTransformations: Allows user to modify the endpoint transformations. - CreateAttempts: Allows user to replay missing messages and send example messages. - ManageEndpoint: Allows user to read/modify any field or configuration of an endpoint (including secrets) By default, the token will get all capabilities if the capabilities are not explicitly specified. |
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. |
featureFlags | string[] | No | — | The set of feature flags the created token will have access to. |
readOnly | boolean | No | — | Whether the app portal should be in read-only mode. |
sessionId | string | No | — | An optional session ID to attach to the token. When expiring tokens with “Expire All”, you can include the session ID to only expire tokens that were created with that session ID. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_id": {
"type": "string",
"description": "The Application's ID or UID."
},
"idempotency-key": {
"type": "string",
"description": "The request's idempotency key"
},
"application": {
"type": "object",
"description": "The application value",
"properties": {
"metadata": {
"type": "object",
"description": "The metadata value"
},
"name": {
"type": "string",
"description": "Application name for human consumption."
},
"rateLimit": {
"type": "integer",
"description": "Deprecated, use `throttleRate` instead."
},
"throttleRate": {
"type": "integer",
"description": "Maximum messages per second to send to this application. Outgoing messages will be throttled to this rate."
},
"uid": {
"type": "string",
"description": "Optional unique identifier for the application."
}
},
"required": [
"name"
]
},
"capabilities": {
"type": "array",
"items": {
"type": "string",
"enum": [
"ViewBase",
"ViewEndpointSecret",
"ManageEndpointSecret",
"ManageTransformations",
"CreateAttempts",
"ManageEndpoint"
]
},
"description": "Custom capabilities attached to the token, You can combine as many capabilities as necessary. The `ViewBase` capability is always required - `ViewBase`: Basic read only permissions, does not allow the user to see the endpoint secret. - `ViewEndpointSecret`: Allows user to view the endpoint secret. - `ManageEndpointSecret`: Allows user to rotate and view the endpoint secret. - `ManageTransformations`: Allows user to modify the endpoint transformations. - `CreateAttempts`: Allows user to replay missing messages and send example messages. - `ManageEndpoint`: Allows user to read/modify any field or configuration of an endpoint (including secrets) By default, the token will get all capabilities if the capabilities are not explicitly specified."
},
"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."
},
"featureFlags": {
"type": "array",
"items": {
"type": "string"
},
"description": "The set of feature flags the created token will have access to."
},
"readOnly": {
"type": "boolean",
"description": "Whether the app portal should be in read-only mode."
},
"sessionId": {
"type": "string",
"description": "An optional session ID to attach to the token. When expiring tokens with \"Expire All\", you can include the session ID to only expire tokens that were created with that session ID."
}
},
"required": [
"PCID",
"app_id"
]
}
svix_applications_v1_authentication_expire_all
Expire All Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
idempotency-key | string | No | — | The request’s idempotency key |
expiry | integer | No | — | How many seconds until the old key is expired. |
sessionIds | string[] | No | — | An optional list of session ids. If any session ids are specified, only Application tokens created with that session id will be expired. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"app_id": {
"type": "string",
"description": "The Application's ID or UID."
},
"idempotency-key": {
"type": "string",
"description": "The request's idempotency key"
},
"expiry": {
"type": "integer",
"description": "How many seconds until the old key is expired."
},
"sessionIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "An optional list of session ids. If any session ids are specified, only Application tokens created with that session id will be expired."
}
},
"required": [
"PCID",
"app_id"
]
}
svix_applications_v1_authentication_logout
Logout Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
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"
},
"idempotency-key": {
"type": "string",
"description": "The request's idempotency key"
}
},
"required": [
"PCID"
]
}
svix_applications_v1_background_task_get
Get Background Task Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
task_id | string | Yes | — | The QueueBackgroundTask’s ID. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"task_id": {
"type": "string",
"description": "The QueueBackgroundTask's ID."
}
},
"required": [
"PCID",
"task_id"
]
}
svix_applications_v1_background_task_list
List Background Tasks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
status | string | No | — | Filter the response based on the status. |
task | string | No | — | Filter the response based on the type. |
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"
},
"status": {
"type": "string",
"description": "Filter the response based on the status.",
"enum": [
"running",
"finished",
"failed"
]
},
"task": {
"type": "string",
"description": "Filter the response based on the type.",
"enum": [
"endpoint.replay",
"endpoint.recover",
"application.stats",
"message.broadcast",
"sdk.generate",
"event-type.aggregate",
"application.purge_content",
"endpoint.bulk-replay"
]
},
"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_applications_v1_environment_export
Export Environment Configuration Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
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"
},
"idempotency-key": {
"type": "string",
"description": "The request's idempotency key"
}
},
"required": [
"PCID"
]
}
svix_applications_v1_environment_import
Import Environment Configuration Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idempotency-key | string | No | — | The request’s idempotency key |
connectors | object[] | No | — | The connectors value |
eventTypes | object[] | No | — | Event Types |
settings | object | No | — | The settings value |
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"
},
"connectors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"allowedEventTypes": {
"type": "array",
"items": {
"type": "string"
},
"description": "Allowed Event Types"
},
"description": {
"type": "string",
"description": "The description value"
},
"featureFlags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Feature Flags"
},
"instructions": {
"type": "string",
"description": "The instructions value"
},
"kind": {
"type": "string",
"enum": [
"Custom",
"AgenticCommerceProtocol",
"CloseCRM",
"CustomerIO",
"Discord",
"Hubspot",
"Inngest",
"Loops",
"Otel",
"Resend",
"Salesforce",
"Segment",
"Sendgrid",
"Slack",
"Teams",
"TriggerDev",
"Windmill",
"Zapier"
],
"description": "The kind value"
},
"logo": {
"type": "string",
"format": "uri",
"description": "The logo value"
},
"name": {
"type": "string",
"description": "The name value"
},
"productType": {
"type": "string",
"enum": [
"Dispatch",
"Stream"
],
"description": "Product Type"
},
"transformation": {
"type": "string",
"description": "The transformation value"
},
"uid": {
"type": "string",
"description": "The Connector's UID."
}
},
"required": [
"name",
"transformation"
]
},
"description": "The connectors value"
},
"eventTypes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"archived": {
"type": "boolean",
"description": "The archived value"
},
"deprecated": {
"type": "boolean",
"description": "The deprecated value"
},
"description": {
"type": "string",
"description": "The description value"
},
"featureFlag": {
"type": "string",
"description": "Deprecated, use `featureFlags` instead."
},
"featureFlags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Feature Flags"
},
"groupName": {
"type": "string",
"description": "The event type group's name"
},
"name": {
"type": "string",
"description": "The event type's name"
},
"schemas": {
"type": "object",
"description": "The schema for the event type for a specific version as a JSON schema."
}
},
"required": [
"description",
"name"
]
},
"description": "Event Types"
},
"settings": {
"type": "object",
"description": "The settings value"
}
},
"required": [
"PCID"
]
}
svix_applications_v1_event_type_create
Create Event Type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idempotency-key | string | No | — | The request’s idempotency key |
archived | boolean | No | — | The archived value |
deprecated | boolean | No | — | The deprecated value |
description | string | Yes | — | The description value |
featureFlag | string | No | — | Deprecated, use featureFlags instead. |
featureFlags | string[] | No | — | Feature Flags |
groupName | string | No | — | The event type group’s name |
name | string | Yes | — | The event type’s name |
schemas | object | No | — | The schema for the event type for a specific version as a JSON schema. |
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"
},
"archived": {
"type": "boolean",
"description": "The archived value"
},
"deprecated": {
"type": "boolean",
"description": "The deprecated value"
},
"description": {
"type": "string",
"description": "The description value"
},
"featureFlag": {
"type": "string",
"description": "Deprecated, use `featureFlags` instead."
},
"featureFlags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Feature Flags"
},
"groupName": {
"type": "string",
"description": "The event type group's name"
},
"name": {
"type": "string",
"description": "The event type's name"
},
"schemas": {
"type": "object",
"description": "The schema for the event type for a specific version as a JSON schema."
}
},
"required": [
"PCID",
"description",
"name"
]
}
svix_applications_v1_event_type_delete
Delete Event Type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
event_type_name | string | Yes | — | The event type’s name |
expunge | boolean | No | — | By default event types are archived when “deleted”. Passing this to true deletes them entirely. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"event_type_name": {
"type": "string",
"description": "The event type's name"
},
"expunge": {
"type": "boolean",
"description": "By default event types are archived when \"deleted\". Passing this to `true` deletes them entirely."
}
},
"required": [
"PCID",
"event_type_name"
]
}
svix_applications_v1_event_type_get
Get Event Type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
event_type_name | string | Yes | — | The event type’s name |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"event_type_name": {
"type": "string",
"description": "The event type's name"
}
},
"required": [
"PCID",
"event_type_name"
]
}
svix_applications_v1_event_type_import_openapi
Event Type Import From Openapi Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idempotency-key | string | No | — | The request’s idempotency key |
dryRun | boolean | No | — | If true, return the event types that would be modified without actually modifying them. |
replaceAll | boolean | No | — | If true, all existing event types that are not in the spec will be archived. |
spec | object | No | — | A pre-parsed JSON spec. |
specRaw | string | No | — | A string, parsed by the server as YAML or JSON. |
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"
},
"dryRun": {
"type": "boolean",
"description": "If `true`, return the event types that would be modified without actually modifying them."
},
"replaceAll": {
"type": "boolean",
"description": "If `true`, all existing event types that are not in the spec will be archived."
},
"spec": {
"type": "object",
"description": "A pre-parsed JSON spec."
},
"specRaw": {
"type": "string",
"description": "A string, parsed by the server as YAML or JSON."
}
},
"required": [
"PCID"
]
}
svix_applications_v1_event_type_list
List Event Types 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 |
include_archived | boolean | No | — | When true archived (deleted but not expunged) items are included in the response. |
with_content | boolean | No | — | When true the full item (including the schema) is included in the response. |
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"
]
},
"include_archived": {
"type": "boolean",
"description": "When `true` archived (deleted but not expunged) items are included in the response."
},
"with_content": {
"type": "boolean",
"description": "When `true` the full item (including the schema) is included in the response."
}
},
"required": [
"PCID"
]
}
svix_applications_v1_event_type_patch
Patch Event Type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
event_type_name | string | Yes | — | The event type’s name |
archived | boolean | No | — | The archived value |
deprecated | boolean | No | — | The deprecated value |
description | string | No | — | The description value |
featureFlag | string | No | — | Deprecated, use featureFlags instead. |
featureFlags | string[] | No | — | Feature Flags |
groupName | string | No | — | The event type group’s name |
schemas | object | No | — | The schemas value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"event_type_name": {
"type": "string",
"description": "The event type's name"
},
"archived": {
"type": "boolean",
"description": "The archived value"
},
"deprecated": {
"type": "boolean",
"description": "The deprecated value"
},
"description": {
"type": "string",
"description": "The description value"
},
"featureFlag": {
"type": "string",
"description": "Deprecated, use `featureFlags` instead."
},
"featureFlags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Feature Flags"
},
"groupName": {
"type": "string",
"description": "The event type group's name"
},
"schemas": {
"type": "object",
"description": "The schemas value"
}
},
"required": [
"PCID",
"event_type_name"
]
}
svix_applications_v1_event_type_update
Update Event Type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
event_type_name | string | Yes | — | The event type’s name |
archived | boolean | No | — | The archived value |
deprecated | boolean | No | — | The deprecated value |
description | string | Yes | — | The description value |
featureFlag | string | No | — | Deprecated, use featureFlags instead. |
featureFlags | string[] | No | — | Feature Flags |
groupName | string | No | — | The event type group’s name |
schemas | object | No | — | The schema for the event type for a specific version as a JSON schema. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"event_type_name": {
"type": "string",
"description": "The event type's name"
},
"archived": {
"type": "boolean",
"description": "The archived value"
},
"deprecated": {
"type": "boolean",
"description": "The deprecated value"
},
"description": {
"type": "string",
"description": "The description value"
},
"featureFlag": {
"type": "string",
"description": "Deprecated, use `featureFlags` instead."
},
"featureFlags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Feature Flags"
},
"groupName": {
"type": "string",
"description": "The event type group's name"
},
"schemas": {
"type": "object",
"description": "The schema for the event type for a specific version as a JSON schema."
}
},
"required": [
"PCID",
"event_type_name",
"description"
]
}
svix_applications_v1_health_get
HealthShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
svix_applications_v1_statistics_aggregate_app_stats
Aggregate App Stats Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
idempotency-key | string | No | — | The request’s idempotency key |
appIds | string[] | No | — | Specific app IDs or UIDs to aggregate stats for. Note that if none of the given IDs or UIDs are resolved, a 422 response will be given. |
since | string | Yes | — | The since value |
until | string | Yes | — | The until value |
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"
},
"appIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "Specific app IDs or UIDs to aggregate stats for. Note that if none of the given IDs or UIDs are resolved, a 422 response will be given."
},
"since": {
"type": "string",
"description": "The since value"
},
"until": {
"type": "string",
"description": "The until value"
}
},
"required": [
"PCID",
"since",
"until"
]
}
svix_applications_v1_statistics_aggregate_event_types
Aggregate Event TypesShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}