register_webhook

Register a new webhook.

Method and URI 

Request

Content

name

  • Name

uri

  • URI for callback

filter

  • Filter for identifying relevant objects

description

  • Short description of the Webhook

errorHandling

  • Short description of the Webhook:
    C: Continue on Error
    E: Error message on error
    Q: Collect to queue (not yet supported

onCreate

  • Call webhook during creation

onUpdate

  • Call webhook when changing

onDelete

  • Call webhook when deleting

isEnabled

  • Webhook is active

Query parameters 

Not required.

Example

Response 

Content 

id

  • Unique  ID

name

  • Name

uri

  • URI for callback

filter

  • Filter for identifying relevant objects

description

  •  Short description of the Webhook

errorHandling

  • Error handling:
    C: Continue on error
    E: Error message on error
    Q: Collect to queue (not yet supported)

onCreate

  • Call webhook during creation

onUpdate

  • Call webhook when changing

onDelete

  • Call webhook when deleting

isEnabled

  • Webhook is active

Beispiel