Skip to content
SalesBuilder
Code
See my plan

Integration.call

Reach any endpoint of a connected account, with your token filled in.

Action class
None
Approval
Runs on its own
Emits
Integration.called
Sites
2 sites
Price
Free
POST https://api.sb/{your-domain}/integrations/call

Sends one request to any endpoint of a connected account, with your token filled in on the server. The hub’s definition of Integration.call.

Inputs

NameTypeDefaultMeaning
integrationIntegrationRequiredThe Integration to call through.
methodstringRequiredThe HTTP method; GET runs at once.
pathstringRequiredThe upstream path, inside the Integration’s grants.
bodyjsonnullThe request body. Unset for a GET, which sends none.

Outputs

FieldTypeWhat null means
statusintegerNever null once the request leaves the platform: the answering API’s own HTTP status, passed through unchanged.
bodyjsonThe answer carried no body, as on a 204.
integrationIntegrationNever null.

Effects

Action class

None: no approval rule names it, so it runs within its seat’s Permissions and Limits

Modes
  • try: Sends a GET as is, since it changes nothing; any other method runs the account’s own validate-only path where one exists, and changes nothing.
  • send: Returns a pending Action: a GET settles at once, any other method after its delay window.
  • do: Waits for the answer and returns its status and body unchanged.
Idempotency

Only with a key: the same Idempotency-Key and input return the first Action, and the same key with other input returns 409. The key never leaves the platform: a POST retried after a timeout replays the first Action instead of posting twice.

Saved or shared

The Action keeps the method, the path and the status that came back. The token never appears in the Action, a log or the response.

Emits

Integration.called with { integration, method, path, status }

Performed by

Integration Engineer

Price

Free on your own account: the platform charges nothing for the call.

On each Venue

SiteFieldsFormats
Google AnalyticsNone.None.
Google Business ProfileNone.None.

Google Analytics

Through Google Analytics.

Google Business Profile

Through Google Business Profile.

What try does

AccountWhat try does
Google AnalyticsReads run for real, because a report changes nothing; try stores no rows, builds no audience and marks no event.
Google Business ProfileReturns the update or the answer as it will show on your profile; nothing posts.

Refuses when

This call has no refusals of its own. Every call through an account can also meet the shared account refusals: grant-missing, needs-reauth, account-not-connected, over-mandate, quota-reached, venue-rejected.

When it waits

FactValue
send returnsFor any method but GET, a pending Action, reason: 'awaitingTime', while its delay window runs; a GET returns done at once.
Delivered byIntegration.called

Example

Text
How many followers does my X account have right now?

To retry, send the same Idempotency-Key: the retry returns the first answer for $0. A new key reads again.

Test values

A sk_test_ key answers these the same way every time, at $0 (every test value).

Test valueAlways returnsWhat it is for
int_test_needs_reauthRefuses with needs-reauthEvery call through it answers as if the account had ended the sign-in, so your reconnect path runs.
int_test_xRefuses with grant-missingIt holds only the post-and-reply grant, so a call to change follows refuses before it leaves the platform.
maxCost: 0.0001Refuses with max-costAny priced call with a maxCost of 0.0001 is refused before it spends: the price is above the cap.
rate-limited.testRefuses with rate-limitedAny call naming this hostname answers 429 with Retry-After, so your retry logic runs.
sources-busy.testRefuses with sources-busyAny call naming this hostname answers 503 as if every route were busy, and nothing is spent.

Used by

Integration.connect

Previous

Handle.connect

Next