Skip to Content
veriom

Subscribe webhook

POST
/v1/workspaces/{workspace_id}/webhooks

Authorization

workspaceToken
headerAuthorizationBearer <vat_<opaque-token>>

Expiring, hashed workspace token with explicit scopes.

Path Parameters

workspace_id*Workspace Id
Formatuuid

Request Body

application/json
  1. body
branch_ref?|null
events*array<string>
Items1 <= items <= 50
kind?Kind
Default"webhook"
Value in"webhook""slack""discord""jira""siem""policy"
name?Name
Length1 <= length <= 255
Default"Webhook"
origin?Origin
Default"all"
Value in"all""manual""schedule""github"
repository_id?|null
url*Url
Formaturi
Length1 <= length <= 2083

Response Body

Successful Response

application/json
  1. response
active*Active
branch_ref?string|null
created_at*Created At
Formatdate-time
events*array<string>
id*Id
Formatuuid
kind*Kind
Value in"webhook""slack""discord""jira""siem""policy"
name*Name
origin?Origin
Default"all"
Value in"all""manual""schedule""github"
repository_id?|null
secret*Secret
url*Url
Example Request
curl -X POST 'https://api.veriom.ai/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/webhooks' \  -H 'Content-Type: application/json' \  -d '{  "events": [    "string"  ],  "url": "http://example.com"}'
Example Response
{  "active": true,  "branch_ref": "string",  "created_at": "2019-08-24T14:15:22Z",  "events": [    "string"  ],  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "kind": "webhook",  "name": "string",  "origin": "all",  "repository_id": "b349ae61-b973-4c6c-a5e0-89183ba99ff3",  "secret": "string",  "url": "string"}