Skip to content

Talking to any system: REST and webhooks

Concept6 minExpert

Beezr can reach out to other systems, and other systems can reach in. Three tools cover both directions. This page helps you pick one.

Which one should I use?

Section titled “Which one should I use?”
You want toUseWhere it lives
Call an app from the Integration hub, such as Slack or QuickBooks OnlineThe Integration stepA workflow step
Call any web service by its addressThe REST API stepA workflow step
Let another system start a workflowThe From a webhook triggerThe workflow’s settings
  1. Another system
  2. Webhook URL
  3. Workflow starts
  4. REST step calls back

The Integration step

Section titled “The Integration step”

Use it first when your app is in the Integration hub. You choose a connection and an action, and the hub handles sign-in. See Connect an app and use it in a workflow.

The REST API step

Section titled “The REST API step”

Use it for any other service. In the step you set the method (GET, POST, PUT, PATCH or DELETE), the address, and how to sign in: None, Username + password, API key or Bearer token. You can add headers and query parameters, and list the fields you want back under What comes back. Name the result under Result so later steps can use it.

The webhook trigger

Section titled “The webhook trigger”

A webhook lets another system start a workflow by calling a URL.

  1. Create a workflow and, under When should it run?, choose From a webhook.
  2. Save it, then open its menu in the workflow list and choose Copy webhook URL.
  3. Paste the URL into the other system.
  4. Turn on Require an API key if callers must send one in the api-key header. Create the key under API keys.
  5. Turn on Send the result back if Beezr should post the outcome to your own URL. Add the Callback URL and choose when to send it: When the run fails, When the run succeeds or Always.

Inside the workflow, a JSON parser step can read the data the webhook sent.

Check yourself

An accounting system must tell Beezr the moment an invoice is paid. Which fits best?
Show the answer

A workflow with the From a webhook trigger. A webhook trigger gives the other system a URL to call, and the workflow starts when it does.

Karim wants a workflow to call a service that has no Integration hub entry. What does he add?
Show the answer

A REST API step. The REST API step calls any HTTP endpoint.

What's next

Create and manage API keysCreate an API key for each system that starts your workflows by webhook, then pause, edit or delete it from one page.Connect an app and use it in a workflowConnect an app in the Integration hub, then add an Integration step to a workflow that reads from or writes to it.

Last checked