Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

API Key authentication for programmatic access. Include your API key in the Authorization header as: Bearer your_api_key_here

Path Parameters

destinationId
string<uuid>
required

Body

application/json
type
string
required
Allowed value: "webhook"
name
string

Human-readable name for this destination

Required string length: 1 - 255
url
string<uri>

The webhook URL to POST to

authType
enum<string>

Type of authentication

Available options:
bearer,
header
headerName
string

Custom header name when authType is "header"

token
string

The authentication token (leave undefined to keep existing)

Response

Successful response

id
string<uuid>
required

Unique identifier for the destination

organizationId
string<uuid>
required

Organization that owns this destination

name
string
required

Human-readable name for this destination

Required string length: 1 - 255
createdAt
string
required

When the destination was created

updatedAt
string
required

When the destination was last updated

type
string
required
Allowed value: "webhook"
config
object
required
usageCount
number
required

Number of detections using this destination

token
string

The authentication token (only returned to authorized users)

hasToken
boolean

Whether a token is configured