Webhooks

Retrieve Webhook

get/webhooks/{id}

Request

Base URL
https://api.companycam.com/v2
Auth
HTTP bearer
TypeScript
https://skmtc.dev/companycam/apis/core-api/docs/webhooks/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring id required

ID of the Webhooks

Response

Details about the webhooks

idstring required

A unique ID for the Webhook.

company_idstring

A unique ID for the Company the Webhook belongs to

urlstring

The URL of the webhook, which will receive requests with data for any events fired that fall within the scopes of the Webhook.

scopesstring[]

A list of scopes covering events the Webhook is subscripted to.

tokenstring

A string used to hash the webhook body for verification.

enabledboolean

Whether or not the Webhook is enabled/active.

created_atinteger

Timestamp when the Webhook was created on the server

updated_atinteger

Timestamp when the Webhook was last updated

Example response

{
  "id": "42",
  "company_id": "8675309",
  "url": "https://sweet-webhooks.com/my/webhook/endpoint",
  "scopes": [
    "*"
  ],
  "token": "123456",
  "enabled": true,
  "created_at": 1490737206,
  "updated_at": 1490737406
}

Changes

No recorded changes to this operation across all 2 revisions of this API.