Webhook

Retrieves the collection of Webhook resources.

Retrieves the collection of Webhook resources.

SecurityBearer
Request
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer >= 0
Default: 30

The number of items per page

Responses
200

Webhook collection

get/webhooks
Request samples 
Response samples 
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}
Creates a Webhook resource.
Creates a Webhook resource.


SecurityBearer 
Request 
Request Body schema: 
required
The new Webhook resource


event
required
string
 Enum: "outgoing-document" "incoming-document"  
url
required
Responses 
201
Webhook resource created


400
Invalid input


422
Unprocessable entity


post/webhooks
Request samples 
{
  • "event": "outgoing-document",
  • "url": "string"
}
Response samples 
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "uuid": "string",
  • "event": "string",
  • "url": "string",
  • "createdAt": "string"
}
Retrieves a Webhook resource.
Retrieves a Webhook resource.


SecurityBearer 
Request 
path Parameters
uuid
required
string
Resource identifier


 
Responses 
200
Webhook resource


404
Resource not found


get/webhooks/{uuid}
Request samples 
Response samples 
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "uuid": "string",
  • "event": "string",
  • "url": "string",
  • "createdAt": "string"
}
Removes the Webhook resource.
Removes the Webhook resource.


SecurityBearer 
Request 
path Parameters
uuid
required
string
Resource identifier


 
Responses 
204
Webhook resource deleted


404
Resource not found


delete/webhooks/{uuid}
Request samples