Menu

Webhooks

AppSignal can send notifications of new incidents to several services, see our full list on the integrations. We also offer webhooks for these notifications so you handle new incidents in your own system.

To receive a webhook, go to the "Notifications" tab the site's sidebar, click the "Add integration" and fill out the URL where you'd like to receive your webhook data.

Webhook

There are multiple webhooks available. Which payloads the webhook receives can be configured in the configuration form for the webhook as seen in the screenshot above.

Deploy markers

JSON
{
  "marker": {
    "time": "2019-01-10 10:45:41 +0100",
    "marker_id": "5c3714455ac13f7df09437f0",
    "site": "My test app",
    "environment": "development",
    "revision": "abc123",
    "user": "tom",
    "repository": "https://github.com/my_org/my_repo",
    "url": "https://appsignal.com/test/sites/5bd867fa2213937f3666ae7b/dashboard"
  }
}

Fields

FieldTypeDescription
markerHash<String, Any>The webhook payload concerns a marker incident.

Deploy marker sub-fields

FieldTypeDescription
timeStringTimestamp at which the deploy marker was created.
marker_idStringInternal AppSignal marker id for the deploy marker.
siteStringApp name as seen on AppSignal.com. Using the site field instead of app for legacy reasons.
environmentStringApp environment of the app as seen on AppSignal.com.
revisionStringThe deploy marker revision name.
userStringThe user that created the marker.
repositoryStringUrl to the repository as configured for the app on AppSignal.com.
urlStringUrl to the app on AppSignal.com that triggered the webhook.

Exception incidents

JSON
{
  "exception": {
    "time": "2019-01-09 09:03:57 UTC",
    "number": 3,
    "site": "My test app",
    "environment": "development",
    "app_url": "https://appsignal.com/test/sites/5bd867fa2213937f3666ae7b",
    "url": "https://appsignal.com/test/sites/5bd867fa2213937f3666ae7b/incidents/3?timestamp=2019-01-09T09%3A03%3A57Z",
    "revision": "abc123",
    "user": "tom",
    "namespace": "web",
    "exception": "Appsignal::Demo::TestError",
    "message": "Hello world! This is an error used for demonstration purposes.",
    "app_backtrace": [
      "/Users/tombruijn/.gem/ruby/2.5.3/gems/appsignal-2.8.1/lib/appsignal/demo.rb:49:in `create_example_error_request'",
      "/Users/tombruijn/.gem/ruby/2.5.3/gems/appsignal-2.8.1/lib/appsignal/demo.rb:35:in `transmit'",
      "/Users/tombruijn/.gem/ruby/2.5.3/gems/appsignal-2.8.1/lib/appsignal/cli/demo.rb:53:in `run'",
      "/Users/tombruijn/.gem/ruby/2.5.3/gems/appsignal-2.8.1/lib/appsignal/cli.rb:31:in `run'",
      "/Users/tombruijn/.gem/ruby/2.5.3/gems/appsignal-2.8.1/bin/appsignal:7:in `<top (required)>'",
      "/Users/tombruijn/.gem/ruby/2.5.3/bin/appsignal:23:in `load'",
      "/Users/tombruijn/.gem/ruby/2.5.3/bin/appsignal:23:in `<top (required)>'",
      "/Users/tombruijn/.gem/ruby/2.5.3/bin/bundle:23:in `<main>'"
    ],
    "first_backtrace_line": "/Users/tombruijn/.gem/ruby/2.5.3/gems/appsignal-2.8.1/lib/appsignal/demo.rb:49:in `create_example_error_request'",
    "action": "DemoController#hello",
    "path": "/hello",
    "hostname": "Toms-MacBook-Pro.local",
    "action_label": "request",
    "metadata": {
      "demo_sample": "true",
      "method": "GET",
      "path": "/hello"
    }
  }
}

Fields

FieldTypeDescription
exceptionHash<String, Any>The webhook payload concerns a exception incident.

Exception sub-fields

FieldTypeDescription
timeStringTimestamp at which the exception occurred.
numberIntegerIncident id as shown on AppSignal.com.
siteStringApp name as seen on AppSignal.com. Using the site field instead of app for legacy reasons.
environmentStringApp environment of the app as seen on AppSignal.com.
app_urlStringUrl to the app on AppSignal.com that triggered the webhook.
urlStringUrl to the specific sample for the incident on AppSignal.com that triggered this webhook.
revisionStringThe deploy marker revision name.
userStringThe user that created the marker. The user value can also be null if not set for a deploy marker revision.
namespaceStringThe namespace in which this exception occurred.
exceptionStringThe exception type that was recorded by AppSignal.
messageStringThe exception message with more details about the exception.
app_backtraceArray<String>The lines of the backtrace concerning the app from which they originated. This excludes any backtrace lines from libraries that are included in the app.
first_backtrace_lineStringThe first backtrace line from the app_backtrace field.
actionStringThe action in which this exception occurred. Either a controller action, background worker or a manually set action.
pathStringThe request path on which the exception occurred. This is only set for web requests. This is metadata set by the AppSignal integration by default and is also included in the metadata field.
hostnameStringThe hostname of the host that this exception occurred on.
action_labelStringA human friendly label for the type of action this exception occurred on. Uses request for the web namespace and job for the background namespace. All other namespaces use action.
metadataHash<String, String>This includes user set metadata (see Tagging feature].

Metadata fields

You can add your own metadata by tagging samples.

FieldTypeDescription
demo_sampleStringSet by the AppSignal integration for demo samples send using our demo command line tool (Ruby / Elixir). Not set for all other samples.
methodStringThe request method used to perform a request. Only available for (web) requests.
pathStringThe request path on which the exception occurred. This is only set for web requests. Contains the same value as the path field.

Performance incidents

JSON
{
  "performance": {
    "time": "2019-01-10 09:38:08 UTC",
    "number": 1,
    "site": "My test app",
    "environment": "development",
    "app_url": "https://appsignal.com/test/sites/5bd867fa2213937f3666ae7b",
    "url": "https://appsignal.com/test/sites/5bd867fa2213937f3666ae7b/incidents/1?timestamp=2019-01-10T09%3A38%3A08Z",
    "revision": "abc123",
    "user": "tom",
    "namespace": "web",
    "duration": 2004.904052734375,
    "action": "DemoController#hello",
    "path": "/hello",
    "hostname": "Toms-MacBook-Pro.local",
    "action_label": "request",
    "metadata": {
      "demo_sample": "true",
      "method": "GET",
      "path": "/hello"
    }
  }
}

Fields

FieldTypeDescription
performanceHash<String, Any>The webhook payload concerns a performance incident.

Performance sub-fields

FieldTypeDescription
timeStringTimestamp at which the performance incident occurred.
numberIntegerIncident id as shown on AppSignal.com.
siteStringApp name as seen on AppSignal.com. Using the site field instead of app for legacy reasons.
environmentStringApp environment of the app as seen on AppSignal.com.
app_urlStringUrl to the app on AppSignal.com that triggered the webhook.
urlStringUrl to the specific sample for the incident on AppSignal.com that triggered this webhook.
revisionStringThe deploy marker revision name.
userStringThe user that created the marker. The user value can also be null if not set for a deploy marker revision.
namespaceStringThe namespace in which this performance incident occurred.
durationFloatThe time in milliseconds measured which the request/job/action took to complete.
actionStringThe action in which this performance incident occurred. Either a controller action, background worker or a manually set action.
pathStringThe request path on which the performance incident occurred. This is only set for web requests. This is metadata set by the AppSignal integration by default and is also included in the metadata field.
hostnameStringThe hostname of the host that this performance incident occurred on.
action_labelStringA human friendly label for the type of action this performance incident occurred on. Uses request for the web namespace and job for the background namespace. All other namespaces use action.
metadataHash<String, String>This includes user set metadata see metadata.

Metadata fields

You can add your own metadata by tagging samples.

FieldTypeDescription
demo_sampleStringSet by the AppSignal integration for demo samples send using our demo command line tool (Ruby / Elixir). Not set for all other samples.
methodStringThe request method used to perform a request. Only available for (web) requests.
pathStringThe request path on which the performance incident occurred. This is only set for web requests. Contains the same value as the path field.

Anomaly detection

JSON
{
  "alert_id": "5bdb1fb301925b0c4b6c7017",
  "state": "closed",
  "site": "google",
  "environment": "production",
  "tags": {
    "namespace": "web"
  },
  "human_tags": ["namespace: web"],
  "metric_name": "transaction_exception_rate",
  "field": "gauge",
  "trigger_label": "Exception rate",
  "trigger_description": "This is a description",
  "last_value": 12.0,
  "peak_value": 20.0,
  "mean_value": 11.0,
  "comparison_operator": "<",
  "comparison_value": 21.0,
  "human_last_value": "12 %",
  "human_peak_value": "20 %",
  "human_mean_value": "11 %",
  "human_comparison_value": "21 %",
  "created_at": "2017-08-01T10:00:00Z",
  "opened_at": "2017-08-01T10:05:00Z",
  "resolved_at": "2017-08-01T12:00:00Z",
  "closed_at": "2017-08-01T13:43:00Z",
  "warmup_duration": 10,
  "cooldown_duration": 20,
  "alert_url": "http://example.com/#{site.account.slug}/sites/#{site.id}/alerts/#{alert.id}",
  "edit_trigger_url": "http://example.com/#{site.account.slug}/sites/#{site.id}/triggers?overlay=triggerForm&triggerId=#{alert.trigger.id}"
}
FieldTypeDescription
alert_idStringInternal AppSignal alert id for the alert.
stateStringState of the alert.
siteStringThe application name alert belongs to.
environmentStringThe application environment name alert belongs to.
tagsArrayNamespace associated with the alert.
human_tagsArrayCustom namespace associated with the alert.
metric_nameStringName of the metric alert was created for.
fieldStringField name of the alert.
trigger_labelStringName of the trigger.
trigger_descriptionStringDescription of the trigger.
last_valueStringLast value recorded for the alert.
peak_valueStringHighest value recorded for the alert
mean_valueStringMean of all values for the alert.
comparison_operatorStringComparison operator set by the user based on which the alert will be triggered.
comparison_valueStringComparison value of the metric set by the user based on which the alert will be triggered.
human_last_valueStringLast metric value that recorded for the alert since it was opened in a more readable format.
human_peak_valueStringHighest value of the metric value that was recorded for the alert while it was open.
human_mean_valueStringMean value of the metric value for the alert while it was open in a more readable format.
human_comparison_valueStringComparison value for the alert metric set by the user based on which the alert will be triggered in a readable format.
created_atStringTimestamp at which the alert was created.
opened_atStringTimestamp (ISO8601) at which the alert was opened.
resolved_atStringTimestamp (ISO8601) at which the alert was resolved.
closed_atStringTimestamp (ISO8601) at which the alert was closed.
warmup_durationStringTime in minutes AppSignal waits before opening a alert.
cooldown_durationStringTime in minutes AppSignal waits before closing a alert.
alert_urlStringURl of the alert so user can view it on AppSignal.
edit_trigger_urlStringURl of the alert so user can edit it on AppSignal.

Integrations list