Optional unique identifier for the endpoint. Must be unique within the application.
urlstring
Required
The webhook endpoint URL that will receive POST requests with event payloads Must use HTTPS and be publicly accessible; localhost and private network URLs will fail delivery.
app_idstring
Required
The application's ID or UID. Use SVIX_APP_CREATE to create an application first.
secretstring
Signing secret for webhook signature verification. Auto-generated if omitted. Must start with 'whsec_' prefix if provided.
versioninteger
Endpoint version number. Defaults to 1 if not specified.
channelsarray
List of message channels to filter. Only messages sent to these channels will be delivered. Omit to receive messages from all channels.
disabledboolean
Set to true to create the endpoint in a disabled state (won't receive webhooks)
rate_limitinteger
Maximum number of webhook deliveries per second. Leave empty for no limit.
descriptionstring
Human-readable description to identify the endpoint's purpose
filter_typesarray
List of event type names to filter. Only these event types will be sent to this endpoint. Omit to receive all event types. Event type names must exactly match; mismatches silently prevent delivery.
Observable output
data
Required
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulboolean
Required
Whether or not the action execution was successful or not