Skip to content

Create and manage API keys

How-to4 minPractitioner

API keys let other systems start your workflows by webhook. Give each system, such as your website or an accounting tool, its own key. Then you can pause one without breaking the others.

Create a key

Section titled “Create a key”
  1. Open Account settings and choose API Integration. The API keys page opens.
  2. Click New key, or Create your first key on a new workspace.
  3. Under Name, type the system that will use it, for example Website orders.
  4. Under Shows as, type a different name for the activity log if you want one. If you leave it empty, Beezr uses the name.
  5. Click Create key.

Beezr shows Your key is ready. Click Copy, paste the key into the other system, then click Done. You can copy the key again from the page at any time.

The New key dialog with a Name field, an optional Shows as field and the Create key button.
    Name the key after the system that will use it.
    Shows as is the name in the activity log. It is optional.
    Create key makes the key.

Manage your keys

Section titled “Manage your keys”

Each row shows the key’s name, a tag (Active or Paused), and the key itself with only its last four characters visible.

The API keys page listing keys, each with its status, a masked value, and icons to show, copy, edit, pause or delete.
    The eye icon shows the key. The copy icon copies it.
    The pencil edits the name. The pause icon pauses the key, and the play icon resumes it.
    The bin deletes the key.
  • Pause refuses the key straight away. Resume lets the system back in.
  • Edit changes the name and the Shows as name. The key itself stays the same.

Where do I use the key?

Section titled “Where do I use the key?”

Systems send the key in the api-key header when they call a workflow’s webhook. Turn on Require an API key in the workflow’s settings. See Start a workflow from another system with a webhook and Talking to any system.

Check yourself

Omar wants to stop his website from starting workflows for a day, without affecting other systems. What does he do?
Show the answer

Pause the website's key. A paused key is refused straight away, and you can resume it later. Other keys keep working.

What does the Shows as name control?
Show the answer

The name shown in the activity log for what the key does. The activity log shows this name for what the key does.

What's next

Talking to any system: REST and webhooksChoose between the REST step, a webhook trigger and the Integration step when Beezr needs to talk to another system.Send email from your own domainAdd a mail server and a sender in Mail setup so workflow emails come from your own address, then check that it works.

Last checked