Proteside Docs
Endpoint referenceWebhooks

Get a webhook

GET
/webhooks/{id}

Authorization

bearerAuth
headerAuthorizationBearer <token>

API token created in Settings → API. Scopes are attached to the token; each operation lists its required scope in x-scope.

Path Parameters

id*string
Formatuuid

Query Parameters

org_id?string

Partners only (orgs:manage): act on this child organization. May also be sent as org_id in JSON bodies.

Formatuuid

Response Body

Webhook

application/json
  1. response
id?string
Formatuuid
org_id?string
Formatuuid
store_id?|

null = organization-wide

Formatuuid
type?string
Value in"webhook""slack""teams"
name?string
url?|
Formaturi
format?string
Value in"json""slack""teams"
has_secret?boolean
events?array<>|

null = all events

min_severity?string
Value in"critical""high""medium""low""info"
active?boolean
last_used_at?|
Formatdate-time
created_at?string
Formatdate-time
updated_at?string
Formatdate-time
curl -X GET "https://example.com/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",  "store_id": "7fe87115-950c-4ae8-bd7e-970406bc9ac0",  "type": "webhook",  "name": "string",  "url": "http://example.com",  "format": "json",  "has_secret": true,  "events": [    "alert.created"  ],  "min_severity": "critical",  "active": true,  "last_used_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}