Requests

A request represent an HTTP request that Hookdeck receives for a source.

When Hookdeck receives a request for a source, it evaluates for each associated connection if an event should be created. In the case where a connection is not eligible for an event, an "Ignored Event" is recorded. Requests no with events created are considered as a "Discarded Request" and may be billed for depending on your plan.

Rejected requests

A request is marked as rejected if a condition for creating events is not met – for example, if the source is disabled.

Rejection causes

Ignored events

If an event is not created for a given connection, for example, because it doesn't pass a filter rule, an ignored event is recorded instead.

Ignored event causes

Retrying a request

Rejected requests can be retried. Hookdeck re-runs the processing logic for the request according to the new result and creates the associated events.

No events will be created for connections that did not exist at the time of original receipt. If new connections have since been added to the source, they will be ignored upon retrying the request.

Additionally, specific ignored events can be retried individually.

Requests eligible for retries

Only rejected requests are eligible for retry. Additionally, you cannot retry requests that have been rejected for the following reasons because they will be rejected again:

• UNSUPPORTED_HTTP_METHOD
• UNSUPPORTED_CONTENT_TYPE
• UNPARSABLE_JSON
• PAYLOAD_TOO_LARGE
• UNKNOWN

Request bulk retries

Rejected requests can be bulk retried from the requests page. The bulk retry dropdown will automatically exclude requests that are not eligible for retry. Bulk retries are done asynchronously and may take some time to complete, a progress bar will be displayed once the retry is submitted.

The bulk retry speed is throttled based on the your project throughput. Increasing the quota will also increase the speed of the bulk retry.

View requests

Hookdeck allows you to browse a historical record of all requests within your retention period, or to filter requests by property. This log is useful for debugging and troubleshooting requests, as well as the events they generate.

Browse all requests

{
  "pagination": {
    "order_by": "created_at",
    "dir": "desc",
    "limit": 1,
    "next": "req_sE7L2cs1Ftn5nUlb8feF"
  },
  "count": 1,
  "models": [
    {
      "id": "req_sE7L2cs1Ftn5nUlb8feF",
      "team_id": "tm_AkLVUIfTy4nn",
      "verified": false,
      "rejection_cause": null,
      "original_event_data_id": "edt_sUZBRp413JM6OSNJk6qc",
      "ingest_priority": "NORMAL",
      "ingested_at": "2022-07-29T13:54:26.514Z",
      "source_id": "src_iEfHpkswbzGW",
      "updated_at": "2022-07-29T13:55:20.360Z",
      "created_at": "2022-07-29T13:55:20.330Z",
      "events_count": 2,
      "cli_events_count": 0,
      "ignored_count": 4
    }
  ]
}

Browse filtered requests

Beneath the Requests link, you can find any custom request views, including Hookdeck's default views: Accepted and Rejected.

Filter requests

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

{
  "pagination": {
    "order_by": "created_at",
    "dir": "desc",
    "limit": 1,
    "next": "req_sE7L2cs1Ftn5nUlb8feF"
  },
  "count": 1,
  "models": [
    {
      "id": "req_sE7L2cs1Ftn5nUlb8feF",
      "team_id": "tm_AkLVUIfTy4nn",
      "verified": false,
      "rejection_cause": null,
      "original_event_data_id": "edt_sUZBRp413JM6OSNJk6qc",
      "ingest_priority": "NORMAL",
      "ingested_at": "2022-07-29T13:54:26.514Z",
      "source_id": "src_iEfHpkswbzGW",
      "updated_at": "2022-07-29T13:55:20.360Z",
      "created_at": "2022-07-29T13:55:20.330Z",
      "events_count": 2,
      "cli_events_count": 0,
      "ignored_count": 4
    }
  ]
}

Filterable properties

The rejection cause and status filters can conflict; in the case where the status is Accepted and a Rejection Cause is set, the status takes precedence.

Inspect a request

Inspecting a request reveals the associated request data, which can be used to understand the flow of events through your system and to troubleshoot issues.

{
  "id": "req_M3ltWOSF8G6oMS9GS9XX",
  "team_id": "tm_AkLVUIfTy4nn",
  "verified": false,
  "rejection_cause": null,
  "original_event_data_id": "edt_3DzFKL5UU8TKsXJjgct7",
  "ingest_priority": "NORMAL",
  "ingested_at": "2022-07-29T13:55:10.238Z",
  "source_id": "src_iEfHpkswbzGW",
  "updated_at": "2022-07-29T13:55:15.369Z",
  "created_at": "2022-07-29T13:55:15.092Z",
  "events_count": 2,
  "cli_events_count": 0,
  "ignored_count": 4,
  "data": {
    "headers": {
      "content-length": "18",
      "content-type": "application/json",
      "postman-token": "56fcfa62-9d0e-450f-a638-474b88f928ea",
      "user-agent": "PostmanRuntime/7.29.2",
      "x-hookdeck-original-ip": "172.18.0.1"
    },
    "body": {
      "example": true
    },
    "query": "",
    "parsed_query": {},
    "path": "/"
  }
}

For each request, the initial request's headers, path, body, and query are provided either as plain text or JSON. Additionally, a list of events and ignored events resulting from that request will be displayed below the request.

Request and event data

A request's associated events (including ignored events) store data. You can see this data in the right-hand sidebar when you select a request and an event. You can use this data to filter Requests, filter Events in the Events dashboard section, and track and resolve issues.

The displayed events depend on the current project view. Only CLI events will display in the CLI view and vice versa.

Request properties

Event properties

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

Ignored event properties

Custom request views

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

Create a custom view

1. Open the Requests page.
2. Make sure Recent Filters 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 Recent Filters 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.