Webhook

Retrieve the collection of Webhook resources.

Retrieve the collection of Webhook resources.

SecurityBearer
Request
query Parameters
page
integer
Default: 1

The collection page number

Responses
200

Webhook collection

400

Bad Request

401

Unauthorized

404

Resource not Found

get/webhooks
Request samples 
Response samples 
application/json
[
  • {
    }
]
Create a Webhook resource.
Create a Webhook resource.


SecurityBearer 
Request 
Request Body schema: application/json
required
The new Webhook resource


legalEntity
string
Legal entity uuid.


 
webhookType
string
Webhook type.


 Enum: "legal-entity-on-boarding-activated" "legal-entity-on-boarding-deactivated" "legal-entity-session-manager" "legal-entity-invoice-sender" "legal-entity-invoice-receiver" "legal-entity-invoice-upo" "legal-entity-invoice-sync"  
webhookUrl
string
Webhook url.


 
Responses 
201
Webhook resource created


400
Invalid input


422
Unprocessable entity


post/webhooks
Request samples 
application/json
{
  • "legalEntity": "string",
  • "webhookType": "legal-entity-on-boarding-activated",
  • "webhookUrl": "string"
}
Response samples 
application/json
{
  • "uuid": "string",
  • "legalEntityUUID": "string",
  • "legalEntityName": "string",
  • "webhookType": "string",
  • "webhookUrl": "string"
}
Retrieve a Webhook resource.
Retrieve 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 
application/json
{
  • "uuid": "string",
  • "legalEntityUUID": "string",
  • "legalEntityName": "string",
  • "webhookType": "string",
  • "webhookUrl": "string"
}
Replace the Webhook resource.
Replace the Webhook resource.


SecurityBearer 
Request 
path Parameters
uuid
required
string
Resource identifier


 
Request Body schema: application/json
required
The updated Webhook resource


legalEntity
string
Legal entity uuid.


 
webhookType
string
Webhook type.


 Enum: "legal-entity-on-boarding-activated" "legal-entity-on-boarding-deactivated" "legal-entity-session-manager" "legal-entity-invoice-sender" "legal-entity-invoice-receiver" "legal-entity-invoice-upo" "legal-entity-invoice-sync"  
webhookUrl
string
Webhook url.


 
Responses 
200
Webhook resource updated


400
Invalid input


404
Resource not found


422
Unprocessable entity


put/webhooks/{uuid}
Request samples 
application/json
{
  • "legalEntity": "string",
  • "webhookType": "legal-entity-on-boarding-activated",
  • "webhookUrl": "string"
}
Response samples 
application/json
{
  • "uuid": "string",
  • "legalEntityUUID": "string",
  • "legalEntityName": "string",
  • "webhookType": "string",
  • "webhookUrl": "string"
}
Remove the Webhook resource.
Remove 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