Skip to main content
PUT
/
v1
/
orgs
/
{org_id}
/
destinations
/
Create a destination
curl --request PUT \
  --url https://api.arklow.io/v1/orgs/{org_id}/destinations/ \
  --header 'Content-Type: application/json' \
  --header 'x-arklow-auth: <api-key>' \
  --data '
{
  "type": "webhook",
  "config": {
    "url": "<string>",
    "headers": {},
    "signaling": {
      "enabled": true,
      "default": "ack"
    },
    "response_time_sla_ms": 2
  },
  "label": "<string>",
  "credential_id": "<string>"
}
'
{
  "data": {
    "id": "<string>",
    "org_id": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "label": "<string>",
    "type": "webhook",
    "config": {
      "url": "<string>",
      "headers": {},
      "signaling": {
        "enabled": true,
        "default": "ack"
      },
      "response_time_sla_ms": 2
    },
    "deleted_at": "2023-11-07T05:31:56Z",
    "tags": {},
    "credential_id": "<string>"
  },
  "errors": [
    {
      "code": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

x-arklow-auth
string
header
required

Path Parameters

org_id
string
required
Pattern: ^[0-9]+$

Body

application/json
type
enum<string>
required
Available options:
webhook
config
object
required
label
string
required
credential_id
string | null
Pattern: ^[0-9]+$

Response

200 - application/json

Default Response

data
object
required
errors
object[] | null
required