Events & Attempts

An event is any outgoing request that Hookdeck queues based on a request, whereas an attempt is a specific delivery tentative that Hookdeck has made for an event.

Events are limited to 50 automatic retries, but can be manually retried as many times as you like.

When receiving a request from a source with multiple connections, Hookdeck creates a separate event for each connection.

View events

Hookdeck allows you to browse a historical record of all events, or to filter and sort events by property.

Browse all events

{
  "pagination": {
    "order_by": "created_at",
    "dir": "desc",
    "limit": 1,
    "next": "evt_njCeMZHzNhJWdkkZ7PLCfEw5"
  },
  "count": 1,
  "models": [
    {
      "id": "evt_njCeMZHzNhJWdkkZ7PLCfEw5",
      "team_id": "tm_nlcetVe8k1lMAY0KR0OxNuHr",
      "webhook_id": "web_UfM5ZY2wxLD6sLhDaKMcx5wp",
      "source_id": "src_9YmY0SHklrv6zBQz78cKGwSW",
      "destination_id": "des_fYYCay655IHwbOMhIaUXtNq2",
      "attempts": 4,
      "response_status": 422,
      "last_attempt_at": "2021-08-02T13:52:16.439Z",
      "next_attempt_at": null,
      "successful_at": "2021-08-01T21:56:35.181Z",
      "updated_at": "2021-08-02T13:52:16.813Z",
      "created_at": "2021-08-01T21:44:57.513Z",
      "status": "FAILED",
      "event_data_id": "evtreq_HlJhb39nsjIP0FDsU3SY0fo7",
      "cli_id": null
    }
  ]
}

Browse filtered events

{
  "pagination": {
    "order_by": "created_at",
    "dir": "desc",
    "limit": 1,
    "next": "evt_njCeMZHzNhJWdkkZ7PLCfEw5"
  },
  "count": 1,
  "models": [
    {
      "id": "evt_njCeMZHzNhJWdkkZ7PLCfEw5",
      "team_id": "tm_nlcetVe8k1lMAY0KR0OxNuHr",
      "webhook_id": "web_UfM5ZY2wxLD6sLhDaKMcx5wp",
      "source_id": "src_9YmY0SHklrv6zBQz78cKGwSW",
      "destination_id": "des_fYYCay655IHwbOMhIaUXtNq2",
      "attempts": 4,
      "response_status": 422,
      "last_attempt_at": "2021-08-02T13:52:16.439Z",
      "next_attempt_at": null,
      "successful_at": "2021-08-01T21:56:35.181Z",
      "updated_at": "2021-08-02T13:52:16.813Z",
      "created_at": "2021-08-01T21:44:57.513Z",
      "status": "FAILED",
      "event_data_id": "evtreq_HlJhb39nsjIP0FDsU3SY0fo7",
      "cli_id": null
    }
  ]
}

Filter and sort events

If your desired filters are not already saved as a filtered view, you can still use the Events page to find the events you're looking for.

1. Open the Events page to see a list of all events, in descending order.
2. Select any properties you'd like to filter on.
3. To sort events, click the header of the first column and select your desired sort property.

Filterable properties

Filtering the request property is not supported for payloads exceeding 2.5 MB. The histogram and total count are disabled when filtering or request

Sortable properties

Inspect an event

Inspecting an event reveals the associated event data, which can be used to understand the flow of requests through your system and to troubleshoot issues.

When selecting an event, the most recent attempt is used to populate the response data. Select any of the other attempts to view their specific response data.

{
  "id": "evt_njCeMZHzNhJWdkkZ7PLCfEw5",
  "team_id": "tm_nlcetVe8k1lMAY0KR0OxNuHr",
  "webhook_id": "web_UfM5ZY2wxLD6sLhDaKMcx5wp",
  "source_id": "src_9YmY0SHklrv6zBQz78cKGwSW",
  "destination_id": "des_fYYCay655IHwbOMhIaUXtNq2",
  "attempts": 4,
  "response_status": 422,
  "last_attempt_at": "2021-08-02T13:52:16.439Z",
  "next_attempt_at": null,
  "successful_at": "2021-08-01T21:56:35.181Z",
  "updated_at": "2021-08-02T13:52:16.813Z",
  "created_at": "2021-08-01T21:44:57.513Z",
  "status": "FAILED",
  "event_data_id": "evtreq_HlJhb39nsjIP0FDsU3SY0fo7",
  "cli_id": null,
  "data": {
    "headers": {
      "content-length": "20",
      "x-original-url": "/e/src_9YmY0SHklrv6zBQz78cKGwSW",
      "cookie": "",
      "x-client-version": "FirebaseCLI/undefined",
      "content-type": "application/json",
      "user-agent": "FirebaseCLI/undefined"
    },
    "body": {
      "test": true
    },
    "query": "",
    "parsed_query": {},
    "path": "/"
  }
}

For each event, the initial request's headers, path, body, and query are provided either as plain text or JSON. Similarly, each attempt's response is provided as plain text or JSON.

Event & attempt data

Events and requests store associated data that let you filter and sort events, and track and resolve issues.

Event data

Event properties

Each event contains properties that can help you track and resolve issues.

Attempt properties

Custom event views

Using custom event views allows you to preserve a filtered view of your events for future access.

Create a custom view

1. Open the Events page.
2. Make sure the filters section is expanded.
3. When the desired filters are set, the results will automatically update.
4. Once satisfied with your filters, click Save View.
5. Name your view and click Save.

Once saved, custom views are accessible in your dashboard's sidebar.

Update filters on a custom view

1. Select the custom view in your dashboard's sidebar.
2. Make sure the filters section is expanded.
3. When the desired filters are set, the results will automatically update.
4. Once satisfied with your filters, click Save View.

Rename a custom view

1. Select the custom view in your dashboard's sidebar.
2. Open the dropdown next to the custom view name at the top of the page, and select Rename.
3. Give your custom view a new name and click Update.

Status and error codes

Below is a reference of Hookdeck's internal event statuses and error codes, as well as some common HTTP status codes.

Hookdeck event status

Hookdeck error codes

If your destination is unreachable or fails to respond, the event will appear in the dashboard with an ERR flag. A more specific error code can be found by inspecting the event.

HTTP response status codes

When your destination responds with a valid HTTP response code, it will be displayed as the event's status. A response code between 200 and 299 is considered successful. A response code of 400 or above is considered a failure.