Skip to content

Integration.call

POST /{namespace}/integrations/{integration}/call

Call sends one request to an upstream through an Integration, with its token filled in server-side, for endpoints no Mapping covers.

Mode
do
Event
Integration.called

Inputs

InputTypeRequiredDescription
integrationIntegrationrequiredThe Integration to call through.
methodstringrequiredThe HTTP method; GET runs at once.
pathstringrequiredThe upstream path, inside the Integration’s grants.
bodyjsonThe request body.

Outputs

OutputTypeRequiredDescription
statusintegerrequiredThe upstream’s status code.
bodyjsonThe upstream’s response body.
integrationIntegrationrequiredThe Integration the request went through.

Effects

  • Emits Integration.called.
  • Performed by the Integration Engineer.
  • One-way (customer): it waits out its delay window, and runs in the send and do modes.
  • Fills the token server-side; no Worker reads it.
  • Runs a GET at once and waits the delay window for any other method until a Mapping classes the endpoint two-way.
  • Refuses a path outside the Integration’s grants before it leaves the platform.
  • try runs the upstream’s own validation and changes nothing.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.Integration.call
A path outside the Integration’s grants before it leaves the platformrefusedClear what the check names, then call it again.Integration.call

When it waits

GateDefault
Decision classMedium: one-way, bounded (customer)
Delay window1 business hour, in which a watcher can pause, redirect or cancel it; then it runs.
LimitThe call Limit of the Permission it runs under.
Over the LimitIt waits pending for an Approval from the Founder. Approved, it runs; refused, it ends refused with limit-exceeded; unanswered by its deadline, it ends canceled.