List webhook endpoints

GET

/webhooks

const url = 'https://acme.gravitastec.com/api/v1/webhooks';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://acme.gravitastec.com/api/v1/webhooks \
  --header 'Authorization: Bearer <token>'

Authorizations

oauth2

Responses

200

Endpoints

application/json

Array

object

url

required

string format: uri

/^https:///

eventTypes

required

Array<string>

Allowed values: document.accepted document.accepted_conditional document.rejected document.delivered document.commercially_approved document.commercially_rejected received_document.arrived range.low

companyIds

Array<string> | null

string format: uuid

status

string

Allowed values: active disabled

disabledReason

string | null

Example

[
  {
    "eventTypes": [
      "document.accepted"
    ],
    "status": "active"
  }
]