Additional dataset options for outbound payloads.
Additional dataset options can be enabled for outbound integration payloads by contacting BigPanda support. These are the dataset options available:
| Option | Definition | Type | Default Integrations |
|---|---|---|---|
| sendComments | Sends an update that includes the comment as part of the metadata when comments are left on the incident. See example below. | Boolean | ServiceNow Jira PagerDuty |
| addEventTypes | Adds an array of event_types to the metadata object in an outbound share. This can be used to understand what type of update was triggered. See example below. | Boolean | All integrations |
| forceIncidentTagUpdates | Sends an update through the share when Incident Tag values are changed. | Boolean | All integrations |
| addMetadata | Includes the environment name and environment ID to the metadata object in each webhook call. See example below. | Boolean | All integrations |
| addIncidentTags | Includes any incident tags in the outbound payloads. See example below. | Boolean | All integrations |
| forceAllUpdates | Allows the incident to be shared even if it's resolved before the AutoShare. This is useful when incidents resolve within a few seconds, but the user still wants an AutoShare. | Boolean | Not default for any integration |
| forceFilterFlappingOrMuted | Suppresses flapping updates, even for integrations typically configured to send them, such as webhooks. If this toggle is on, BigPanda will wait to send updates until the system confirms the alert is no longer flapping. The default delay for this is 1 hour, but it may be different depending on your organization's flapping configuration. | Boolean | Not default for any integration |
| forceOneTime | Only sends the initial share to the target. Further updates are suppressed. | Boolean | Not default for any integration |
| quota | Contains share quota information for the integration. Attributes:used - The number of shares sent through the integration since it was last reset.available - The number of shares the integration is allowed to send before the next reset is performed.last_reset - The timestamp of when the used count was last reset to zero.notified - Flag indicating whether the organization has been notified that their quota was reached. | JSON | Not default for any integration |
Example of sendComments option
sendComments optionmetadata: { sender: { name: '<USERS_NAME>', email: '<USERS_EMAIL>' }, comment: { comment: 'Hello World', environment: 'All' } }
Example of addEventTypes option
addEventTypes option "event_types":[ { "event":"incident#new", "time":1674571309 }, { "event":"incident-tag#upserted", "time":1674571309 } ]
Example of addMetadata option
addMetadata option metadata: { sender: { name: '<USERS_NAME>', email: '<USERS_EMAIL>' }, environment: '<ENVIRONMENT_NAME_THAT_PERFORMED_THE_SHARE>', environment_id: '<ENVIRONMENT_ID>' }
Example of addIncidentTags option
addIncidentTags option incidentTags: [ { id: 'host', value: 'production-database-01'}, { id: 'check', value: 'CPU-01'}, { id: 'application', value:'bigpanda'}, ]