Create a Linked Service
Linked services are configured per assistant, alongside its other settings.
Before You Start
- Have an assistant already created. See [Build a Perfect
Assistant](build-assistant.md) if you don't have one yet.
- Know the endpoint you want to call — its URL, method and (if it needs one) the header
and value used to authenticate.
Steps
- Open your assistant and go to the Linked services tab.
- Choose Add linked service.
- In the dialog, fill in:
- Service ID — a unique, short handle your actions will use (e.g.
orders_api). - Method —
GET,POST,PUTorDELETE. - URL — the full endpoint, starting with
https://.
- (Optional) Under Authentication, set a Header name (such as
Authorization)
and its Secret value. See Authenticate requests.
- (Optional) Under Headers, add request headers whose values can include
{{params.x}}
placeholders. See Pass dynamic values.
- Save service, then Apply the assistant configuration.
Verify the Result
The service appears in the list showing its method, endpoint and — if you added one — an Auth badge. Trigger the action that calls it (or the form wired to it) and confirm the response shows up in the conversation.
IDs must be unique
Each service id keys its own configuration and credential, so two services can't share an id. The editor flags a clash before you save.
Troubleshooting
- Save is disabled — a required field (Service ID or URL) is empty, or the URL doesn't
start with http:// or https://.
- "Set an auth header name to attach the secret to." — you entered a secret value but
left the header name blank. Add the header name, or clear the secret.
Related Docs
- Call a linked service — wire an action to it.
- Authenticate requests — add a credential that stays server-side.