Register an endpoint; the signing secret is returned once

POST

/webhooks

curl --request POST \
  --url https://acme.gravitastec.com/api/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "url": "https://example.com", "eventTypes": [ "document.accepted" ], "companyIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ] }'

Authorizations

• oauth2

Request Body^required

Media typeapplication/json

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

Responses

201

Created

Media typeapplication/json

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

id

string format: uuid

status

string

Allowed values: active disabled

disabledReason

string | null

secret

Shown only once

string

Example

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

403

Limit_exceeded (plan without API access

422

All validation errors with field paths; the document is not numbered

Media typeapplication/problem+json

object

type

string

title

string

status

integer

code

string

errors

Array<object>

object

path

string

message

string

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}