OrkStageOrkStage
API referenceWebhooks

POST /webhooks

POST /webhooks: OrkStage Control API v1 endpoint reference.

POST
/api/v1/webhooks

Authorization

headerAuthorizationBearer <token>

Organization API key (scoped). Sessions use the cookie instead.

Header Parameters

x-orkstage-csrf?unknown

Cookie sessions: send "1" on POST/PATCH/PUT/DELETE. Not needed with an API key.

Request Body

application/json
  1. body
url*string
Formaturi
Lengthlength <= 2000
description?string
Lengthlength <= 200
Default""
events*array<>
Items1 <= items
tenantId?string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Response Body

curl -X POST 'http://localhost:4300/api/v1/webhooks' \  -H 'Content-Type: application/json' \  -d '{  "url": "http://example.com",  "events": [    "deployment.started"  ]}'
Empty
Edit on GitHub

GET /webhooks GET

GET /webhooks: OrkStage Control API v1 endpoint reference.

PATCH /webhooks/{id} PATCH

PATCH /webhooks/{id}: OrkStage Control API v1 endpoint reference.