Register a webhook destination — server token only

POST

/v1/webhooks

curl --request POST \
  --url http://localhost:3000/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "url": "https://acme.com/dropin-hooks" }'

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

object

url

required

string format: uri

Example

https://acme.com/dropin-hooks

Responses

201

Destination created (Outpost returns its id + signing secret).

Media typeapplication/json

object

Example^generated

{}

403

Authenticated but not permitted.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: VALIDATION_FAILED UNAUTHENTICATED FORBIDDEN NOT_FOUND CONFLICT RATE_LIMITED INTERNAL

message

required

string

requestId

required

string

fields

Present only for VALIDATION_FAILED.

Array<object>

object

path

string

message

string

Example

{
  "error": {
    "code": "VALIDATION_FAILED"
  }
}