Webhook

Integrate your agents with the outside world via APIs. You can use webhooks as triggers to a workflow and actions to hit APIs.

​

Triggers

Incoming hook: Send a request to a custom URL to trigger a workflow. It can be whatever method you want, though we do recommend using POST. There’s no pre-defined schema for the request, so you can send whatever body, headers, and query parameters you want. That schema will define the variables available for the subsequent actions in the workflow.

If you’re at the testing stage of an incoming hook trigger and don’t know how to send the request, consider using postman or other tools to test your request. You can also use the following command line example:

curl https://workflows.platform.happyrobot.ai/hooks/<id> -d '{"number": "+11234567890"}'

This will tell the system what to expect once you publish the workflow. Think of what inputs you want to pass to the workflow, such as a phone number to call, the name of the person, some of the details of a shipment, etc.

If you’re sending a JSON body and you don’t see the schema being parsed by the platform, consider adding a Content-Type: application/json header to the request.

Polling: We poll your API to get data at a regular interval. Coming soon.

​

Actions

POST: Send a POST request to a custom URL. Specify the body and headers you want to send. You can also specify the authorization you want to use:

• No Auth: Send a request without any authorization.
• API Key: Send an api-key header with the value.
• Bearer Token: Send a bearer token in the Authorization header.
• Basic Auth: Send a username and password in the headers.

GET: Send a GET request to a custom URL. Specify the query parameters and headers you want to send. Authorization is the same as for POST.