Webhooks

You can set up webhook endpoints for new inbound entries. Whenever a new entry comes in, the payload (the feedback from your user) is sent to the webhook endpoint.

How to set up a webhook endpoint

Go to your Webhooks, you can find it under Settings. Here look up the stream you want to set up webhooks for, add the URL and enable it.

Preview of the rules edit screen

Receiving webhooks

With the webhook enabled, anytime a new inbound entry is created, a POST request with the following payload is sent:

POST /webhook/endpoint HTTP/1.1
User-Agent: Helptail Webhooks (https://helptail.com)
Content-Type: application/json

{
  "type": "entry.created",
  "id": "007ea8b78d5b27adacdbc0f2d09ef44ff68673e0",
  "version": "2021-11-22",
  "occurred_at": "2022-01-01T00:00:00Z",
  "payload": {
    "entry": {
      "id": "1122e2c8",
      "name": "Inbound Stream #2",
      "url": "https://example.com",
      "ip": "127.0.0.0"
    },
    "status": "complete"
    // any other key/value pair based on your stream,
    // eg. "email": "support@helptail.com"
  }
}

The specified URL should respond with an OK response (eg. 200..299) quickly. If an error is returned, sending is retried with exponential backoff.

When the endpoint keeps returning an error code, the endpoint is automatically disabled.