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

Responses
200

Webhook collection

400
401
404
get/webhooks
Request samples
Response samples
application/json
[
  • {
    }
]

Creates a Webhook resource.

Creates a Webhook resource.

SecurityBearer
Request
Request Body schema: application/json

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"
}

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
application/json
{
  • "uuid": "string",
  • "legalEntityUUID": "string",
  • "legalEntityName": "string",
  • "webhookType": "string",
  • "webhookUrl": "string"
}

Replaces the Webhook resource.

Replaces the Webhook resource.

SecurityBearer
Request
path Parameters
uuid
required
string

Resource identifier

Request Body schema: application/json

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"
}

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