Create a Workflow step
Creates a new Workflow Step based on a single provided step and returns a webhook URL that can be used to invoke the Workflow Step and retrieve a response. When creating a Workflow write action step, field values can be hardcoded, or they can contain mapped values. The mapped values should be surrounded with double curly braces.
In the example request body the Workflow Step contains the field values email
, name
, phone
, and address
in double curly braces. Then the webhook URL returned can be called with a POST
request containing a JSON body in the following format:
{
"email": "user@example.com",
"name": "John Doe",
"phone": "1234567890",
"address": "123 Maple Lane"
}
Note that authentications may become invalid over time, and if this occurs, users will be notified by email to fix their authentication. If the authentication is not fixed, trying to run the Workflow Step will time out. Workflow Steps are also (for now) visible and editable as Zaps at https://zapier.com/app/zaps. If a user turns off a Workflow Step Zap, the request will similarly time out. Finally, it is possible that a user can edit the Workflow Step Zap such that it returns unexpected outputs.
This API is rate limited. See Rate Limiting for more details.
OAuth
This endpoint requires the zap:write
OAuth scope.
Authorizations
See our OAuth2 authentication documentation
Body
See here to get started.
Response
Webhook URL used to invoke the Workflow Step and retrieve a response.