Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WebhookDto

Hierarchy

  • WebhookDto

Index

Constructors

Properties

Constructors

constructor

Properties

additionalHeaders

additionalHeaders: {}

Additional headers that will be send when calling the webhook URL

Type declaration

  • [key: string]: string

id

id: string

Id of the webhook configuration, can be used for update/delete

signatureKey

signatureKey: string

If configured, additional header Webhook-Sha256-Hmac will be send also containing Sha256 HMAC calculated using this key. The header can be used to verify, that the origin of the message is Get It Done system and not a malicious actor.

url

url: string

Url for event delivery, data is submitted as plain JSON The URL can contain {} placeholders, which will be replaced by the respective field in the payload. Example: http://example.com/order/{invoicingExternalId}/event

version

version: string

Version of the events that should be delivered to this webhook

Generated using TypeDoc