GatewayAPI
Send SMS worldwide through GatewayAPI's REST API.
Connect it with: API key. GatewayAPI's own documentation: https://gatewayapi.com/docs/apis/rest/.
What agents can do
Connect GatewayAPI so the agents working your tasks can reach it. With it connected, they can:
- Send an SMS to one or many recipients, for example a status alert or a verification code.
- Check the account's remaining credit before a large send.
- Look up the delivery status of messages sent earlier.
Before you start
- A GatewayAPI account with credit, at gatewayapi.com or on the EU platform at gatewayapi.eu.
- A sender name or number allowed in the destination countries (GatewayAPI's dashboard lists each country's sender rules).
- A Jaah account. Anyone can add a personal secret; an organization secret needs an Org Owner or Admin.
Connect with GatewayAPI
Jaah connects to GatewayAPI with an API key, not with a sign-in button.
Connect with an API key
Find each value first:
- Platform: https://gatewayapi.com for an account you sign in to at gatewayapi.com; https://gatewayapi.eu for an account on the EU platform at gatewayapi.eu.
- API token: GatewayAPI dashboard > Settings > API Keys: select Create API Key (or an existing key) and copy its Token.
Then add it to Jaah:
- In Jaah, open Secrets, select New, and pick the GatewayAPI card.
- Name the secret and choose who can use it.
- Fill in Platform, API token.
- Select Save. Jaah tests the secret straight away (see Test the connection).
Jaah encrypts what you type and never shows it again — not to you, and not to an admin.
Use your own OAuth app
Not used: Jaah connects to GatewayAPI with an API key, not through an OAuth app.
Test the connection
Select Test on the secret. Jaah calls GatewayAPI's API once (GET <Platform>/rest/me) with the stored values, and shows who it answered as, or which value GatewayAPI refused and the status it answered. Jaah also tests automatically when you save or reconnect.
The last result and its time stay on the secret's page, so you can see whether it still works without testing again.
Who can use it
Every secret has an owner, and the owner decides who can use it:
- Personal — only your own tasks can use it. This is the default.
- Organization — every task in the organization can use it. Only Org Owners and Admins can choose this.
- Attached to a project — every task on that project can use it, whoever started the task. See Attach a secret to a project.
More on owners and access: How secrets work.
Use it in an agent session
An agent asks for the secret with its credential_get tool, by the secret's path, when it needs it, and gets the values for that one call. The path is the owner's prefix and the secret's name:
org/<name>for an organization secret,projects/<project>/<name>for one attached to a project,me/<name>for your personal one.
A key connection hands the agent its fields: base_url, api_token.
Tell the agent in your task description which secret to use, for example “use the GatewayAPI secret org/gatewayapi”.
Manage, rotate or disconnect
Everything is on the secret's page under Secrets:
- Rotate a key: create a new key at the vendor first, then select Replace on the secret and paste it. Revoke the old key at GatewayAPI once the test passes. Steps: Replace or delete a secret.
- Disconnect: select Delete. The stored values are destroyed and agents lose access on their next call. To end access at GatewayAPI's side too, revoke or delete the key at GatewayAPI.
Limitations
- A token from one platform does not work on the other: pick the Platform you sign in to.
- Every SMS is charged from the account's credit; Jaah does not cap what agents send.
- Agents can do only what the connected GatewayAPI account allows.
Troubleshooting
Test says GatewayAPI rejected the API token (401)
Check the Platform: a gatewayapi.eu token is rejected by gatewayapi.com and the other way round. Otherwise copy the token again from Settings > API Keys and select Replace on the secret.
Messages are rejected for the sender
Some countries do not allow alphanumeric sender names. Use a number as sender for them, as the dashboard's country rules describe.
Still stuck? Select Test and read the result: it names the value GatewayAPI refused and the status it answered.
FAQ
Does GatewayAPI need a username as well?
No. The token alone authenticates; Jaah sends it as Authorization: Token.
Can Jaah or an admin see the key or token?
No. Jaah stores it encrypted and never shows it again. Only the tasks allowed to use the secret receive it, at the moment they ask for it.
Can I connect more than one GatewayAPI account?
Yes. Add one secret per account, each with its own name, and tell the agent which one to use.