How do I configure a custom Web Hook?

This page is now deprecated. For the latest version, please click here.

Crashlytics has built custom Web Hooks to integrate our advanced crash reporting into your work flow.

To enable a custom web hook, you'll need to provide the URL of your server. To add the URL, select your app here and click on "Web Hook" to configure it.

When you enable a custom Web Hook, the service behind your URL must respond to two POST requests - Verification and Issue Impact Change. 

1. Verification

When you configure your Web Hook, Crashlytics will send a verification to the provided URL. The POST will have a 'verification' parameter, and the body will be JSON of the form:

{
  "event": "verification",
  "payload_type": "none"
}

Your service must respond with a 200 level status code for the verification to succeed.

2. Issue Impact Change

The notification will occur only once per issue, when it hits the threshold (impact level) you set.  At this time, Crashlytics will POST JSON of the form:

{
  "event": "issue_impact_change",
  "payload_type": "issue",
  "payload": {
    "display_id": 123 ,
    "title": "Issue Title" ,
    "method": "methodName of issue",
    "impact_level": 2,
    "crashes_count": 54,
    "impacted_devices_count": 16,
    "url": "http://crashlytics.com/full/url/to/issue"
} }

The POST will contain all the basic information about the issue:

  • Title
  • Subtitle
  • Number of crashes recorded so far
  • Number of impacted devices recorded so far
  • Display number
  • Current impact level

It will also include the direct URL to the issue page on our dashboard.

Your service must respond with a 200 level status code to this POST. Crashlytics will try a couple more times if the service fails to respond initially. 

Once your service responds, you're all set!  Happy coding!

Feedback and Knowledge Base