API Reference

Create workflow automation

post
https://tenants-gateway-api-sbx.sidedrawersbx.com/api/v1/tenants/workflows-automation/tenant/tenant-id//automations

Creates a new workflow automation with webhook or time-based triggers. For webhook triggers, automatically creates the necessary webhook subscription.

Path Params
string
required

Tenant identifier.

Body Params
string

The affiliate code (brandCode) is an identifier for the "brand" or "affiliate" within a Tenant. The affiliate code is the version of the brand name that appears in the URL. A brand name may be "Corporate ABC", for example. Then the affiliate code might be something like "corporate-abc".

string
required

Human-readable name for the workflow automation.

trigger
object
required

Trigger configuration that defines when the automation should execute.

decisions
object
required

Decision rules and facts that determine which actions to execute based on the provided context.

actions
array of objects
required

Array of actions to execute when rule conditions are met. Actions can be marketplace requests or other automations.

actions*
Response

Updated 8 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago