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.
- Noun
- Integration
- Mode
do- Event
Integration.called
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
integration | Integration | required | The Integration to call through. |
method | string | required | The HTTP method; GET runs at once. |
path | string | required | The upstream path, inside the Integration’s grants. |
body | json | The request body. |
Outputs
| Output | Type | Required | Description |
|---|---|---|---|
status | integer | required | The upstream’s status code. |
body | json | The upstream’s response body. | |
integration | Integration | required | The 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
sendanddomodes. - Fills the token server-side; no Worker reads it.
- Runs a
GETat 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.
tryruns the upstream’s own validation and changes nothing.
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use 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 platform | refused | Clear what the check names, then call it again. | Integration.call |
When it waits
| Gate | Default |
|---|---|
| Decision class | Medium: one-way, bounded (customer) |
| Delay window | 1 business hour, in which a watcher can pause, redirect or cancel it; then it runs. |
| Limit | The call Limit of the Permission it runs under. |
| Over the Limit | It 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. |