Via Webhook

To start a process via webhook, do the following:

1. Log in to your account

2. Click Administration > Processes > Template Diagrams > The card of the process you want to start

3. Click Start Process > Via webhook > New Webhook.

• Description - The name of the webhook

• URL - The URL of the webhook

Field Mapping

To map information from your parent source to your process, enter the name of your Source field in the field that corresponds with your ProcessPlan field. Click Save at the top of the panel.

ProcessPlan looks for each source field name in the incoming request’s query string, headers, form fields, and JSON body. For values nested inside a JSON payload, use a path as the source field name, for example customer.name or items[0].sku.

Inspect the raw payload

It isn’t always obvious what field names another system sends in its webhook payload. ProcessPlan captures the raw payload so you can look:

1. Add a field of type Serialized Data to your process template (see Process Fields).

2. Send a test request to the webhook URL from your source system.

3. Open the process instance that was started and look at the Serialized Data field. It contains the complete raw payload exactly as the source system sent it.

4. Use the field names and paths you see there as the Source field names in your field mapping.

Note

The payload is saved into the first Serialized Data field on the template that isn’t already receiving a value through field mapping. If you only want to use the field temporarily to discover the payload structure, you can remove it from the template once your mapping is set up.