Webhook Payloads

Below are some examples of Webhook Payload Capabilities

Events for attachments (Upload, Update and Delete)

This is enabled via a registry key on the System: When the "Include all attachments in payload" option is enabled it will include the attachments of that entity in the payload. Example: { "Action": "Forwarded", "Call": { "Ref": 757, ...omitted for ease of reading } }, "Attachments": [ { "Ref": 1720, "Name": "Test3.txt", "FileSize": 12, "ContentType": "text/plain", "Data": "VGVzdCBjb250ZW50" }, { "Ref": 1719, "Name": "NewTest1.txt", "FileSize": 12, "ContentType": "text/plain", "Data": "VGVzdCBjb250ZW50" } ] }

Additional Options:

  • "Attachment Name Filter" - Allows the admin to configure regular expressions to filter what attachments get included by their name. multiple regular expressions can be defined separated by a semi colon ";"

  • "Attachment Size Limit" - Allows the admin to configure a max size of attachment to be included. When greater than 0 (no limit), it will filter what attachments get included based on file size (in kilobytes).

  • "Number of Attachments per Payload Limit" - The maximum number of attachments to be included in the payload. When greater than 0 (no limit), it will select the newest (uploaded/updated most recently) attachments, until the limit is reached.

A new activity log entry will be added for webhooks which indicate what attachments have been included/excluded from the payload.

Inline images when they are contained within HTML

Events for the following entity types

  • Call

  • CMDB item

  • Knowledge

  • CMDB Link

  • Person

  • Request

  • Task

Last Note Added

You can add the last note added to a ticket as part of the webhook payload.

Include All Attachments

You can include all the attachments to be sent (as long as they meet the configured criteria):

This is enabled via a registry key on the System:

When the "Include all attachments in payload" option is enabled it will include the attachments of that entity in the payload.

Example:

{
  "Action": "Forwarded",
  "Call": {
    "Ref": 757,
    ...omitted for ease of reading
    }
  },
  "Attachments": [
    {
      "Ref": 1720,
      "Name": "Test3.txt",
      "FileSize": 12,
      "ContentType": "text/plain",
      "Data": "VGVzdCBjb250ZW50"    },
    {
      "Ref": 1719,
      "Name": "NewTest1.txt",
      "FileSize": 12,
      "ContentType": "text/plain",
      "Data": "VGVzdCBjb250ZW50"    }
  ]
}

Additional Options:

  • "Attachment Name Filter" - Allows the admin to configure regular expressions to filter what attachments get included by their name. multiple regular expressions can be defined separated by a semi colon ";"

  • "Attachment Size Limit" - Allows the admin to configure a max size of attachment to be included. When greater than 0 (no limit), it will filter what attachments get included based on file size (in kilobytes).

  • "Number of Attachments per Payload Limit" - The maximum number of attachments to be included in the payload. When greater than 0 (no limit), it will select the newest (uploaded/updated most recently) attachments, until the limit is reached.

A new activity log entry will be added for webhooks which indicate what attachments have been included/excluded from the payload.

Last updated