Skip to main content
POST
/
api
/
destinations
Create destination
curl --request POST \
  --url https://app.outlit.ai/api/destinations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "WEBHOOK_ENDPOINT",
  "name": "Customer ops",
  "description": null,
  "enabled": true,
  "url": "https://hooks.example.com/outlit"
}
'
{
  "ok": true,
  "commandId": "<string>",
  "commandVersion": 123,
  "correlationId": "<string>",
  "result": {
    "operationId": "<string>",
    "status": "<string>",
    "resources": [
      {
        "type": "<string>",
        "id": "<string>"
      }
    ],
    "data": {
      "destination": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "key": "<string>",
        "name": "<string>",
        "description": "<string>",
        "enabled": true,
        "maskedConfig": {},
        "lastSyncedAt": "2023-11-07T05:31:56Z",
        "providerErrorCode": "<string>",
        "providerErrorMessage": "<string>",
        "isDefault": true,
        "schemaVersion": "<string>",
        "configHash": "<string>",
        "archivedAt": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    },
    "warnings": [
      "<string>"
    ],
    "auditId": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Outlit API key using the Bearer ok_... format.

Body

application/json
​
name
string
required
Required string length: 1 - 120
​
url
string<uri>
required
Pattern: ^(https://|http://(localhost|127\.0\.0\.1|\[::1\]|::1)([:/]|$))
​
type
string
default:WEBHOOK_ENDPOINT
Allowed value: "WEBHOOK_ENDPOINT"
​
description
string | null
Maximum string length: 1000
​
enabled
boolean
default:true

Response

Destination was created.

​
ok
boolean
required
​
commandId
string
required
Allowed value: "destination.create"
​
commandVersion
integer
required
​
correlationId
string
required
​
result
object
required