Subscription Actions

Subscription Actions

Actions define delivery mechanisms for subscription results. Each action specifies where and how signal outputs should be sent when the subscription triggers.

Supported action types:

  • webhook — Deliver results to an HTTP endpoint

Multiple actions of the same type are allowed on a single subscription, up to a maximum of 10 actions per subscription.

Note: Subscription action webhooks are currently delivered without HMAC signatures. Do not rely on request signatures to authenticate incoming payloads from subscription actions.

List all actions for a subscription

get

Retrieve a paginated list of actions configured on a subscription.

Authorizations
AuthorizationstringRequired

API key authentication using Bearer token. Format: sk_live_ followed by a secure random string.

Path parameters
subscriptionIdstring · uuidRequired

The subscription whose actions to list

Query parameters
limitinteger · min: 1 · max: 100Optional

Maximum number of actions to return

Default: 20
offsetintegerOptional

Number of actions to skip for pagination

Default: 0
Responses
chevron-right
200

Actions retrieved successfully

application/json
totalintegerRequired

Total number of actions for the subscription

Example: 3
limitintegerRequired

Maximum number of actions returned

Example: 20
offsetintegerRequired

Number of actions skipped

Example: 0
hasMorebooleanRequired

Whether there are more actions available

Example: false
get
/v1/companies/signals/subscriptions/{subscriptionId}/actions

Create a subscription action

post

Create an action on a subscription. Actions define what happens when the subscription triggers (e.g., deliver results via webhook). A maximum of 10 actions per subscription is allowed.

Authorizations
AuthorizationstringRequired

API key authentication using Bearer token. Format: sk_live_ followed by a secure random string.

Path parameters
subscriptionIdstring · uuidRequired

The subscription to add the action to

Body

Create a new action on a subscription. The type field determines which configuration object is required.

typestring · enumRequired

The action type discriminator

Example: webhookPossible values:
Responses
post
/v1/companies/signals/subscriptions/{subscriptionId}/actions

Get a subscription action by ID

get

Retrieve a single action by its ID.

Authorizations
AuthorizationstringRequired

API key authentication using Bearer token. Format: sk_live_ followed by a secure random string.

Path parameters
subscriptionIdstring · uuidRequired

The subscription that owns the action

actionIdstring · uuidRequired

The action ID

Responses
chevron-right
200

Action retrieved successfully

application/json

A subscription action resource.

idstring · uuidRequired

The action ID

subscriptionIdstring · uuidRequired

The subscription this action belongs to

typestring · enumRequired

The action type discriminator

Possible values:
enabledbooleanRequired

Whether the action is enabled. Disabled actions are skipped during dispatch.

Default: true
createdAtstring · date-timeRequired

When the action was created

updatedAtstring · date-timeRequired

When the action was last updated

get
/v1/companies/signals/subscriptions/{subscriptionId}/actions/{actionId}

Update a subscription action

put

Replace the configuration of an existing action. The action type is immutable; only the type-specific configuration can be updated.

Authorizations
AuthorizationstringRequired

API key authentication using Bearer token. Format: sk_live_ followed by a secure random string.

Path parameters
subscriptionIdstring · uuidRequired

The subscription that owns the action

actionIdstring · uuidRequired

The action ID to update

Body

Update the configuration of an existing action. The action type is immutable; only the type-specific configuration can be changed.

Responses
chevron-right
200

Action updated successfully

application/json

A subscription action resource.

idstring · uuidRequired

The action ID

subscriptionIdstring · uuidRequired

The subscription this action belongs to

typestring · enumRequired

The action type discriminator

Possible values:
enabledbooleanRequired

Whether the action is enabled. Disabled actions are skipped during dispatch.

Default: true
createdAtstring · date-timeRequired

When the action was created

updatedAtstring · date-timeRequired

When the action was last updated

put
/v1/companies/signals/subscriptions/{subscriptionId}/actions/{actionId}

Delete a subscription action

delete

Permanently delete an action from a subscription.

Authorizations
AuthorizationstringRequired

API key authentication using Bearer token. Format: sk_live_ followed by a secure random string.

Path parameters
subscriptionIdstring · uuidRequired

The subscription that owns the action

actionIdstring · uuidRequired

The action ID to delete

Responses
delete
/v1/companies/signals/subscriptions/{subscriptionId}/actions/{actionId}

No content

Pause a subscription action

post

Disable an action so it is skipped during dispatch. The action configuration is preserved and can be re-enabled with unpause.

Authorizations
AuthorizationstringRequired

API key authentication using Bearer token. Format: sk_live_ followed by a secure random string.

Path parameters
subscriptionIdstring · uuidRequired

The subscription that owns the action

actionIdstring · uuidRequired

The action ID to pause

Responses
chevron-right
200

Action paused successfully

application/json

A subscription action resource.

idstring · uuidRequired

The action ID

subscriptionIdstring · uuidRequired

The subscription this action belongs to

typestring · enumRequired

The action type discriminator

Possible values:
enabledbooleanRequired

Whether the action is enabled. Disabled actions are skipped during dispatch.

Default: true
createdAtstring · date-timeRequired

When the action was created

updatedAtstring · date-timeRequired

When the action was last updated

post
/v1/companies/signals/subscriptions/{subscriptionId}/actions/{actionId}/pause

Unpause a subscription action

post

Re-enable a paused action so it resumes being dispatched when the subscription triggers.

Authorizations
AuthorizationstringRequired

API key authentication using Bearer token. Format: sk_live_ followed by a secure random string.

Path parameters
subscriptionIdstring · uuidRequired

The subscription that owns the action

actionIdstring · uuidRequired

The action ID to unpause

Responses
chevron-right
200

Action unpaused successfully

application/json

A subscription action resource.

idstring · uuidRequired

The action ID

subscriptionIdstring · uuidRequired

The subscription this action belongs to

typestring · enumRequired

The action type discriminator

Possible values:
enabledbooleanRequired

Whether the action is enabled. Disabled actions are skipped during dispatch.

Default: true
createdAtstring · date-timeRequired

When the action was created

updatedAtstring · date-timeRequired

When the action was last updated

post
/v1/companies/signals/subscriptions/{subscriptionId}/actions/{actionId}/unpause

Last updated