/svix-messaging | Type: Application | PCID required: Yes
Tools
svix_messaging_v1_endpoint_bulk_replay
Bulk Replay Messages Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
channel | string | No | — | The channel value |
eventTypes | string[] | No | — | Event Types |
since | string | Yes | — | The since value |
status | integer | No | — | The sending status of the message: - Success = 0 - Pending = 1 - Fail = 2 - Sending = 3 |
statusCodeClass | integer | No | — | The different classes of HTTP status codes: - CodeNone = 0 - Code1xx = 100 - Code2xx = 200 - Code3xx = 300 - Code4xx = 400 - Code5xx = 500 |
tag | string | No | — | The tag value |
until | string | No | — | The until value |
svix_messaging_v1_endpoint_create
Create Endpoint Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
channels | string[] | No | — | List of message channels this endpoint listens to (omit for all). |
description | string | No | — | The description value |
disabled | boolean | No | — | The disabled value |
filterTypes | string[] | No | — | Filter Types |
headers | object | No | — | The headers value |
metadata | object | No | — | The metadata value |
rateLimit | integer | No | — | Deprecated, use throttleRate instead. |
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. |
throttleRate | integer | No | — | Maximum messages per second to send to this endpoint. Outgoing messages will be throttled to this rate. |
uid | string | No | — | Optional unique identifier for the endpoint. |
url | string | Yes | — | The url value |
svix_messaging_v1_endpoint_delete
Delete Endpoint Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
svix_messaging_v1_endpoint_get
Get Endpoint Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
svix_messaging_v1_endpoint_get_headers
Get Endpoint Headers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
svix_messaging_v1_endpoint_get_secret
Get Endpoint Secret Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
svix_messaging_v1_endpoint_get_stats
Endpoint Stats Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
since | string | No | — | Filter the range to data starting from this date. |
until | string | No | — | Filter the range to data ending by this date. |
svix_messaging_v1_endpoint_list
List Endpoints Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’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 |
svix_messaging_v1_endpoint_patch
Patch Endpoint Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
channels | string[] | No | — | The channels value |
description | string | No | — | The description value |
disabled | boolean | No | — | The disabled value |
filterTypes | string[] | No | — | Filter Types |
metadata | object | No | — | The metadata value |
rateLimit | integer | No | — | Deprecated, use throttleRate instead. |
throttleRate | integer | No | — | Maximum messages per second to send to this endpoint. Outgoing messages will be throttled to this rate. |
uid | string | No | — | The Endpoint’s UID. |
url | string | No | — | The url value |
svix_messaging_v1_endpoint_patch_headers
Patch Endpoint Headers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
deleteHeaders | string[] | No | — | A list of headers be be removed |
headers | object | Yes | — | The headers value |
svix_messaging_v1_endpoint_patch_transformation
Patch Endpoint Transformation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’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 |
svix_messaging_v1_endpoint_recover
Recover Failed Webhooks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
since | string | Yes | — | The since value |
until | string | No | — | The until value |
svix_messaging_v1_endpoint_replay_missing
Replay Missing Webhooks Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
since | string | Yes | — | The since value |
until | string | No | — | The until value |
svix_messaging_v1_endpoint_rotate_secret
Rotate Endpoint Secret Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
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. |
svix_messaging_v1_endpoint_send_example
Send Event Type Example Message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
eventType | string | Yes | — | The event type’s name |
exampleIndex | integer | No | — | If the event type schema contains an array of examples, chooses which one to send. Defaults to the first example. Ignored if the schema doesn’t contain an array of examples. |
svix_messaging_v1_endpoint_transformation_get
Get Endpoint Transformation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
svix_messaging_v1_endpoint_update
Update Endpoint Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
channels | string[] | No | — | List of message channels this endpoint listens to (omit for all). |
description | string | No | — | The description value |
disabled | boolean | No | — | The disabled value |
filterTypes | string[] | No | — | Filter Types |
metadata | object | No | — | The metadata value |
rateLimit | integer | No | — | Deprecated, use throttleRate instead. |
throttleRate | integer | No | — | Maximum messages per second to send to this endpoint. Outgoing messages will be throttled to this rate. |
uid | string | No | — | Optional unique identifier for the endpoint. |
url | string | Yes | — | The url value |
svix_messaging_v1_endpoint_update_headers
Update Endpoint Headers Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
headers | object | Yes | — | The headers value |
svix_messaging_v1_message_attempt_expunge_content
Delete attempt response body Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
msg_id | string | Yes | — | The Message’s ID or UID. |
attempt_id | string | Yes | — | The MessageAttempt’s ID. |
svix_messaging_v1_message_attempt_get
Get Attempt Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
msg_id | string | Yes | — | The Message’s ID or UID. |
attempt_id | string | Yes | — | The MessageAttempt’s ID. |
svix_messaging_v1_message_attempt_list_attempted_destinations
List Attempted Destinations 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 |
app_id | string | Yes | — | The Application’s ID or UID. |
msg_id | string | Yes | — | The Message’s ID or UID. |
svix_messaging_v1_message_attempt_list_attempted_messages
List Attempted Messages 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 |
channel | string | No | — | Filter response based on the channel |
tag | string | No | — | Filter response based on the message tags |
status | integer | No | — | Filter response based on the status of the attempt: Success (0), Pending (1), Failed (2), or Sending (3) |
before | string | No | — | Only include items created before a certain date |
after | string | No | — | Only include items created after a certain date |
with_content | boolean | No | — | When true message payloads are included in the response |
app_id | string | Yes | — | The Application’s ID or UID. |
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
event_types | string[] | No | — | Filter response based on the event type |
svix_messaging_v1_message_attempt_list_by_endpoint
List Attempts By Endpoint 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 |
status | integer | No | — | Filter response based on the status of the attempt: Success (0), Pending (1), Failed (2), or Sending (3) |
status_code_class | integer | No | — | Filter response based on the HTTP status code |
channel | string | No | — | Filter response based on the channel |
tag | string | No | — | Filter response based on the tag |
before | string | No | — | Only include items created before a certain date |
after | string | No | — | Only include items created after a certain date |
with_content | boolean | No | — | When true attempt content is included in the response |
with_msg | boolean | No | — | When true, the message information is included in the response Note that message payloads are never included in the response, regardless of this flag. |
event_types | string[] | No | — | Filter response based on the event type |
app_id | string | Yes | — | The Application’s ID or UID. |
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
svix_messaging_v1_message_attempt_list_by_msg
List Attempts By Msg 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 |
status | integer | No | — | Filter response based on the status of the attempt: Success (0), Pending (1), Failed (2), or Sending (3) |
status_code_class | integer | No | — | Filter response based on the HTTP status code |
channel | string | No | — | Filter response based on the channel |
tag | string | No | — | Filter response based on the tag |
endpoint_id | string | No | — | Filter the attempts based on the attempted endpoint |
before | string | No | — | Only include items created before a certain date |
after | string | No | — | Only include items created after a certain date |
with_content | boolean | No | — | When true attempt content is included in the response |
app_id | string | Yes | — | The Application’s ID or UID. |
msg_id | string | Yes | — | The Message’s ID or UID. |
event_types | string[] | No | — | Filter response based on the event type |
svix_messaging_v1_message_attempt_resend
Resend Webhook Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
msg_id | string | Yes | — | The Message’s ID or UID. |
endpoint_id | string | Yes | — | The Endpoint’s ID or UID. |
svix_messaging_v1_message_create
Create Message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
with_content | boolean | No | — | When true, message payloads are included in the response. |
application | object | No | — | The application value |
channels | string[] | No | — | List of free-form identifiers that endpoints can filter by |
deliverAt | string | No | — | 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. |
eventId | string | No | — | Optional unique identifier for the message |
eventType | string | Yes | — | The event type’s name |
payload | object | Yes | — | JSON payload to send as the request body of the webhook. We also support sending non-JSON payloads. Please contact us for more information. |
payloadRetentionHours | integer | No | — | Optional number of hours to retain the message payload. Note that this is mutually exclusive with payloadRetentionPeriod. |
payloadRetentionPeriod | integer | No | — | Optional number of days to retain the message payload. Defaults to 90. Note that this is mutually exclusive with payloadRetentionHours. |
tags | string[] | No | — | List of free-form tags that can be filtered by when listing messages |
transformationsParams | object | No | — | Extra parameters to pass to Transformations (for future use) |
svix_messaging_v1_message_expunge_all_contents
Expunge all message contents Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
svix_messaging_v1_message_expunge_content
Delete message payload Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
msg_id | string | Yes | — | The Message’s ID or UID. |
svix_messaging_v1_message_get
Get Message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
msg_id | string | Yes | — | The Message’s ID or UID. |
with_content | boolean | No | — | When true message payloads are included in the response. |
svix_messaging_v1_message_list
List Messages Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
limit | integer | No | — | Limit the number of returned items |
iterator | string | No | — | The iterator returned from a prior invocation |
channel | string | No | — | Filter response based on the channel. |
before | string | No | — | Only include items created before a certain date. |
after | string | No | — | Only include items created after a certain date. |
with_content | boolean | No | — | When true message payloads are included in the response. |
tag | string | No | — | Filter messages matching the provided tag. |
event_types | string[] | No | — | Filter response based on the event type |
svix_messaging_v1_message_poller_consumer_poll
Poller Consumer Poll Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
sink_id | string | Yes | — | The Endpoint’s ID or UID. |
consumer_id | string | Yes | — | Consumer Id |
limit | integer | No | — | Limit the number of returned items |
iterator | string | No | — | The iterator returned from a prior invocation |
svix_messaging_v1_message_poller_consumer_seek
Poller Consumer Seek Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
sink_id | string | Yes | — | The Endpoint’s ID or UID. |
consumer_id | string | Yes | — | Consumer Id |
after | string | Yes | — | The after value |
svix_messaging_v1_message_poller_poll
Poller Poll Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
sink_id | string | Yes | — | The Endpoint’s ID or UID. |
limit | integer | No | — | Limit the number of returned items |
iterator | string | No | — | The iterator returned from a prior invocation |
event_type | string | No | — | Filters messages sent with this event type (optional). |
channel | string | No | — | Filters messages sent with this channel (optional). |
after | string | No | — | The after value |
svix_messaging_v1_message_precheck
Create Message Precheck Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
app_id | string | Yes | — | The Application’s ID or UID. |
channels | string[] | No | — | The channels value |
eventType | string | Yes | — | The event type’s name |

