Support > Apps > Webhook App

This App sends a notification to your Webhook when a capture is done. You can find a full version of this guide on our blog.

Configure your HTTP Webhook

We support HTTP and HTTPS webhook, but we strongly recommend using HTTPS. Your webhook should process notifications within 60 seconds and return 200 OK.

Blit will send one notification for capture, with information about all URLs in the capture. We send a POST request in this format:

User-Agent: Blitapp/Webhook
Content-Type: application/json

{
  "type": "production",
  "version": "v1",
  "date": "2019-11-03T20:01:16.313Z",
  "capture": {
    "name": "My capture",
    "urls": [
      {
        "url": "https://www.example.com/",
        "image": "https://blitapp-images.com/file?query_sring",
        "status": "OK"
      }
    ]
  }
}

Headers:

• User-Agent: Blitapp/Webhook
• Content-Type: application/json

Post body:

The information is sent as JSON:

• type: production or test (when verifying an app)
• version: v1, we may increase the version if we add more information
• date: the date at which the webhook notification was sent in your timezone
• capture: the details of your capture:
  • name: the name of your capture
  • urls: information about all the URLs in your capture:
    • url: the URL requested
    • image: the link to the screenshot
    • status: OK or ERROR

Configure your App

Go to Apps and click Add an App. Choose Webhook as the type. Enter a name for your Webhook type.

Then, you should test your webhook by clicking on "Verify". A request with the format (type: "test") above will be sent to your webhook. If any problem occurs, it will be reported.

Use your App

You can add your App to one or many captures. Go to your capture, click on the Apps input box and select your Webhook App.