Custom APIs

HTTP API key

Call any HTTPS API that authenticates with an API key header, with the key stored once on the connection and kept out of workflow definitions.

01 / Workflows

What you can automate.

The HTTP API key connection stores an API key, the header it is sent in, and the API's base URL, which must be HTTPS. HTTP steps that use the connection get the header added for them and can only call URLs under that base URL.

  1. Read and update records in a system that has no built-in agent.
  2. Send orders or status updates to a partner's REST API.
  3. Pull prices or stock levels from a supplier API.

02 / Capabilities

What it covers.

The full reference, with connection types, is in the HTTP API key docs.

Capabilities

  • API key sent in the header you name
  • Requests pinned to one HTTPS base URL
  • Credentials kept out of workflow definitions

Data handled

  • Request and response bodies
  • Response status and headers

03 / Availability

In every edition.

HTTP API key is a standard integration, included in Cloud, Enterprise and the open-source engine. Compare plans

  • Open-source engineAGPL-3.0, run and operate it yourself.Included
  • CloudWe host and manage your instance.Included
  • EnterpriseYour cloud or on-premises, supported by our team.Included

04 / Questions

Common questions.

Is HTTP API key included in my plan?

Yes. HTTP API key is a standard integration, included in Cloud, Enterprise and the open-source engine.

How is it set up?

A connection stores the HTTP API key credentials once for your instance. Workflow steps that use it declare that connection, and the runtime denies anything else.

Can a person approve before anything is written?

Yes. A workflow holds an exception for approval and continues only after the person decides. The run keeps the source, the decision, who made it, and the response together.

More in Custom APIs

Connect the system you need.

Start with a paid pilot of one real process. Our team builds and runs it, live in two weeks once access is in place.

Discuss your process

All product names, logos and brands are the property of their respective owners and are used here in good faith, only to identify the systems Runtara connects to. Their use does not imply any affiliation with, or endorsement or sponsorship by, those owners.