Last updated on October 23, 2026
Any platform call: request
Call the end customer's platform's own API, for anything the shared shapes do not cover.
What request does
request calls the end customer's platform's own API, for anything the shared shapes do not cover. It works on every platform switched on for you, including ones with no unified data yet.
const answer = await appnigma.request({
endCustomerId: "lawfirm-123",
platform: "hubspot",
method: "GET",
path: "/crm/v3/objects/notes?limit=10",
});
if (answer.status === 200) console.log(answer.body);answer = client.request(
end_customer_id: "lawfirm-123",
platform: "hubspot",
method: "GET",
path: "/crm/v3/objects/notes?limit=10"
)
puts answer[:body] if answer[:status] == 200answer = client.request(
end_customer_id="lawfirm-123",
platform="hubspot",
method="GET",
path="/crm/v3/objects/notes?limit=10",
)
if answer["status"] == 200:
print(answer["body"])What you send
Names are shown as in TypeScript. Ruby and Python use the same names in snake case: end_customer_id.
Your own id for your customer. 1 to 100 characters of letters, digits, dot, dash or underscore.
The platform, such as hubspot. It must be switched on for your company.
GET, POST, PUT, PATCH or DELETE.
A path on the platform's own API, with its query, such as /crm/v3/objects/notes?limit=10. Never a full address. It cannot step out of that API, so .. and //host are refused.
Sent as JSON. Leave it out on a GET.
What you get back
The answer is the platform's own. A refusal from the platform comes back the same way, with its status, rather than as an error: check status.
The platform's HTTP status.
The platform's content type, paging and rate limit headers, when it sent them.
JSON when the platform answered JSON, text otherwise, empty when there was nothing.
Retries
A GET is tried again only when that is safe, up to three times by default. See Retries and time limits.
Any method other than GET is made once and never tried again, because only you know whether repeating it is harmless.