WayloAIWaylo Docs
APIReferenceDestinations

Create destination

POST
/destinations

Add a place a session’s result is sent after the call. The signing secret is in the response and is never retrievable again. Requires CREDENTIAL_ENCRYPTION_KEY to be configured (503 otherwise).

Access: workspace_admin · API key destinations:write

Authorization

api-key
headerAuthorizationBearer <sk_waylo_<lookup><secret><checksum>>

Header Parameters

Authorization*string

Your API key.

Request Body

application/json
  1. body
workspaceId*string
Formatuuid
name*string
Lengthlength <= 100
url*string
Lengthlength <= 2048
credentialId?|
Formatuuid
sendTestCalls?boolean

Also deliver for calls started from the dashboard, marked as tests.

Defaultfalse
instructions?string

Added to the prompt of every agent that uses the destination: what the agent tells the caller about the hand-off. Empty adds nothing.

Lengthlength <= 2000
Default""

Response Body

Created, with the signing secret

application/json
  1. response
destination*
signingSecret*string

Shown once. Not retrievable afterwards.

Example Request
curl -X POST 'https://api.poc.app.waylovoice.ai/destinations' \  -H 'Authorization: Bearer sk_waylo_...' \  -H 'Content-Type: application/json' \  -d '{  "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",  "name": "string",  "url": "https://orders.example.com/notes"}'
Example Response
{  "destination": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",    "name": "string",    "url": "string",    "credentialId": "f568fec0-10b6-4b94-9daf-e62c50c9bf3e",    "credentialName": "string",    "credentialActive": true,    "sendTestCalls": true,    "instructions": "string",    "active": true,    "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",    "createdByUserName": "string",    "updatedByUserId": "b38eaad7-8efa-49e7-b0aa-619916a3821e",    "updatedByUserName": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  },  "signingSecret": "string"}

Resend delivery POST

Send a delivered or failed delivery again, from the first attempt of the schedule. The same body and the same id are sent, so a receiver that already holds it keeps one. **Access:** workspace_admin · API key `sessions:write`

Get destination GET

One destination, by id. Never includes a secret. **Access:** workspace_viewer · API key `destinations:read`