API Reference

Automation and Event Gateway API Reference

Complete REST API reference for building automations and webhook infrastructure with FastHook: create Workflows, manage versioned graphs, inspect Workflow runs, configure Sources and Destinations, connect routing rules, retry failed events, transform payloads, query metrics, and manage authentication or project secrets.

Use these endpoints to automate event-driven work, debug Workflow Actions and webhook delivery, search activity by time range or status, create temporary public request bins, and operate replay-safe integrations through the public API at api.fasthook.io.

The FastHook CLI mirrors the same API surface. Use resource commands such as fasthook sources list, or call any route directly with fasthook api <method> <path> and JSON from --json or --json-file.

122 endpointsapi.fasthook.ioUI uses /api/auth and /api/controlCLI mirrors REST API commands/v1 prefix optional

Download OpenAPI Generated project-key OpenAPI (partial)

Overview

FastHook REST API is available at api.fasthook.io. The dashboard UI calls same-origin proxy routes under /api/auth and /api/control, but external integrations should use the public REST base URL. Every route may optionally start with /v1, so /v1/sources and /sources are equivalent.

Routing and tenancy input parameters

Routing and tenancy accepts the route, header, query, and body inputs listed below.

Routing and tenancy headers

AuthorizationstringRequired

Bearer API key or session token. Used by the Routing and tenancy operation.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team. Used by the Routing and tenancy operation.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/sources" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

Text

REST host:
api.fasthook.io

Version prefix:
/v1

Headers:
Authorization: Bearer fhsess_20260510_demo_session_token_7k9m2p4q
x-team-id: tm_3b5335b627084a838b

Dashboard UI proxy:
/api/auth/me
/api/control/sources

Equivalent paths:
/v1/sources
/sources

Authentication

Create and inspect dashboard sessions. Profile updates require a user session.

Authentication response fields

6 fields

user.id

Stable user identifier for the authenticated FastHook account.

user.email

Email address attached to the authenticated user.

user.name

Display name saved on the user profile.

user.picture_url

Profile image URL when the identity provider supplies one.

session.expires_at

ISO timestamp when the returned dashboard session token expires.

memberships[].team_id

Team IDs the user can access through the authenticated session.

id_token or credentialstringRequired

required Google ID token Used by the Login with Google operation.

team_idstringOptional

optional team ID used to scope the session Used by the Login with Google operation.

Request

Shell

curl -X POST \
  "https://api.fasthook.io/v1/auth/google/login" \
  -H "Content-Type: application/json" \
  --data '{
  "id_token": "google_id_token_20260510_01jv8b7r6s9p2x4m",
  "credential": "google_credential_20260510_01jv8b7r6s9p2x4m",
  "team_id": "tm_3b5335b627084a838b"
}'

Response

JSON

{
  "ok": true,
  "token": "fhsess_20260510_demo_session_token_7k9m2p4q",
  "team_id": "tm_3b5335b627084a838b",
  "expires_at": "2026-05-10T18:00:00.000Z",
  "is_new_user": true,
  "user": {
    "id": "usr_01jv8b8j7k3m6q2p9x4r5t6y7z",
    "email": "andrew@example.com",
    "name": "Andrew Lencmanis",
    "picture_url": null
  }
}

Get current profile input parameters

Get current profile does not require path, query, or body parameters.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/auth/me" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "ok": true,
  "team_id": "tm_3b5335b627084a838b",
  "session": {
    "expires_at": "2026-05-10T18:00:00.000Z"
  },
  "user": {
    "id": "usr_01jv8b8j7k3m6q2p9x4r5t6y7z",
    "email": "andrew@example.com",
    "name": "Andrew Lencmanis",
    "picture_url": null
  },
  "memberships": [
    {
      "team_id": "tm_3b5335b627084a838b",
      "role": "owner",
      "slug": "default-project",
      "name": "Default Project"
    }
  ]
}

Update profile input parameters

Update profile accepts the route, header, query, and body inputs listed below.

Update profile request body

namestringRequired

required string, max 120 characters Used by the Update profile operation.

Update profile notes

Both PATCH and PUT are accepted for profile updates.

Request

Shell

curl -X PATCH \
  "https://api.fasthook.io/v1/auth/me" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "name": "Andrew Lencmanis"
}'

Response

JSON

{
  "ok": true,
  "team_id": "tm_3b5335b627084a838b",
  "session": {
    "expires_at": "2026-05-10T18:00:00.000Z"
  },
  "user": {
    "id": "usr_01jv8b8j7k3m6q2p9x4r5t6y7z",
    "email": "andrew@example.com",
    "name": "Andrew Lencmanis",
    "picture_url": null
  },
  "memberships": [
    {
      "team_id": "tm_3b5335b627084a838b",
      "role": "owner",
      "slug": "default-project",
      "name": "Default Project"
    }
  ]
}

Logout input parameters

Logout does not require path, query, or body parameters.

Workflows

Workflows connect one Source trigger to an acyclic graph of Actions, Destinations, transformations, filters, delays, and Paths. Updates increment the version so clients can detect concurrent edits, while runs retain the exact version used for execution.

Workflows response fields

14 fields

idwfl_*

Unique Workflow ID. Workflow IDs use the wfl_ prefix.

team_id

Team that owns the Workflow.

source_id

Source whose accepted events trigger this Workflow.

name

Human-readable Workflow name, unique within the team.

description

Optional operational description, up to 4000 characters.

statusdraft | active | paused | disabled

Workflow lifecycle state: draft, active, paused, or disabled.

version

Monotonically increasing graph version used for concurrent-edit protection and run evidence.

source

Trigger Source metadata, including provider definition and output schema when available.

steps

Ordered graph nodes for Actions, Destinations, transformations, filters, delays, and Paths.

edges

Directed routes that connect the Trigger or an earlier Step to a downstream Step.

steps_count

Number of Steps currently stored in the Workflow graph.

edges_count

Number of Edges currently stored in the Workflow graph.

created_at

ISO timestamp when the Workflow was created.

updated_at

ISO timestamp when the Workflow was last changed.

Workflows shared request body fields

namestringRequired

required on create, max 155 characters; optional on update

descriptionstringOptional

optional string or null, max 4000 characters

source_idstringRequired

required on create; optional on update

statusenumOptional

draft | active | paused | disabled; defaults to active on create

versionintegerOptional

current integer version on update; stale versions return 409

stepsarrayOptional

graph Step array, max 100

edgesarrayOptional

graph Edge array, max 250

List workflows input parameters

List workflows accepts the route, header, query, and body inputs listed below.

List workflows query parameters

limitintegerOptional

defaults to 100, max 255 Used by the List workflows operation.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/workflows?limit=100" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "count": 1,
  "models": [
    {
      "id": "wfl_01jv8d2m7q4r9x3p6n5k1s0t8b",
      "team_id": "tm_3b5335b627084a838b",
      "source_id": "src_q6z62b6py5o79b",
      "name": "Notify the team about new orders",
      "description": "Send each new order to the operations channel.",
      "status": "active",
      "version": 3,
      "source": {
        "id": "src_q6z62b6py5o79b",
        "name": "New orders",
        "type": "WEBHOOK",
        "status": "enabled",
        "provider_key": null,
        "definition_key": null
      },
      "steps_count": 1,
      "edges_count": 1,
      "capabilities": {
        "trigger_input": true,
        "step_output_input": true,
        "branching": true,
        "fan_out": true
      },
      "created_at": "2026-08-27T09:20:00.000Z",
      "updated_at": "2026-08-27T10:15:00.000Z"
    }
  ]
}

Create a workflow input parameters

Create a workflow uses the shared request body fields above together with any route, header, or query inputs listed here.

Create a workflow notes

A Workflow may contain at most 100 Steps and 250 Edges.
The graph must be acyclic and every Step must have an input Edge from the Trigger or another Step.

Request

Shell

curl -X POST \
  "https://api.fasthook.io/v1/workflows" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "name": "Notify the team about new orders",
  "description": "Send each new order to the operations channel.",
  "source_id": "src_q6z62b6py5o79b",
  "status": "draft",
  "steps": [],
  "edges": []
}'

Response

JSON

{
  "id": "wfl_01jv8d2m7q4r9x3p6n5k1s0t8b",
  "team_id": "tm_3b5335b627084a838b",
  "source_id": "src_q6z62b6py5o79b",
  "name": "Notify the team about new orders",
  "description": "Send each new order to the operations channel.",
  "status": "draft",
  "version": 1,
  "steps": [],
  "edges": [],
  "steps_count": 0,
  "edges_count": 0,
  "created_at": "2026-08-27T09:20:00.000Z",
  "updated_at": "2026-08-27T09:20:00.000Z"
}

Retrieve a workflow input parameters

Retrieve a workflow accepts the route, header, query, and body inputs listed below.

Retrieve a workflow path parameters

idstringRequired

Workflow ID. Used by the Retrieve a workflow operation.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/workflows/wfl_01jv8d2m7q4r9x3p6n5k1s0t8b" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "id": "wfl_01jv8d2m7q4r9x3p6n5k1s0t8b",
  "team_id": "tm_3b5335b627084a838b",
  "source_id": "src_q6z62b6py5o79b",
  "name": "Notify the team about new orders",
  "status": "active",
  "version": 3,
  "source": {
    "id": "src_q6z62b6py5o79b",
    "name": "New orders",
    "type": "WEBHOOK",
    "status": "enabled",
    "provider_key": null,
    "definition_key": null,
    "output_schema": {},
    "export_path": null,
    "primary_output": null,
    "sample": null
  },
  "steps": [
    {
      "id": "wfs_notify_slack",
      "kind": "action",
      "name": "Send Slack message",
      "resource_id": "wfs_notify_slack",
      "action": {
        "provider_key": "slack",
        "action_key": "send_message"
      },
      "config": { "enabled": true },
      "position": { "x": 560, "y": 120 }
    }
  ],
  "edges": [
    {
      "id": "wfe_trigger_to_slack",
      "source_type": "trigger",
      "source_step_id": null,
      "source_port": "default",
      "target_step_id": "wfs_notify_slack",
      "target_port": "input",
      "mapping": { "version": 1, "mode": "passthrough" },
      "condition": null,
      "position": 0
    }
  ]
}

Update a workflow input parameters

Update a workflow uses the shared request body fields above together with any route, header, or query inputs listed here.

Update a workflow path parameters

idstringRequired

Workflow ID. Used by the Update a workflow operation.

Update a workflow notes

Send the version returned by the latest read. A stale version returns 409 workflow_conflict.
PUT and PATCH currently use the same partial-update behavior.

Request

Shell

curl -X PUT \
  "https://api.fasthook.io/v1/workflows/wfl_01jv8d2m7q4r9x3p6n5k1s0t8b" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "version": 3,
  "status": "paused"
}'

Response

JSON

{
  "id": "wfl_01jv8d2m7q4r9x3p6n5k1s0t8b",
  "name": "Notify the team about new orders",
  "status": "paused",
  "version": 4,
  "steps_count": 1,
  "edges_count": 1,
  "updated_at": "2026-08-27T10:15:00.000Z"
}

Delete a workflow input parameters

Delete a workflow accepts the route, header, query, and body inputs listed below.

Delete a workflow path parameters

idstringRequired

Workflow ID. Used by the Delete a workflow operation.

Delete a workflow notes

Deletion is destructive and there is no Workflow restore endpoint.
Pause or disable the Workflow first and retain required graph, version, run, and business evidence before deletion.

Request

Shell

curl -X DELETE \
  "https://api.fasthook.io/v1/workflows/wfl_01jv8d2m7q4r9x3p6n5k1s0t8b" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "id": "wfl_01jv8d2m7q4r9x3p6n5k1s0t8b",
  "deleted": true
}

List workflow runs input parameters

List workflow runs accepts the route, header, query, and body inputs listed below.

List workflow runs path parameters

idstringRequired

Workflow ID. Used by the List workflow runs operation.

List workflow runs query parameters

limitintegerOptional

defaults to 100, max 255 Used by the List workflow runs operation.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/workflows/wfl_01jv8d2m7q4r9x3p6n5k1s0t8b/runs?limit=100" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "count": 1,
  "models": [
    {
      "id": "wfr_01jv8d5p3x7r2q9m6n4k1s0t8b",
      "request_id": "req_01jv8c3m7b2p4q9x6r5t1n0k8s",
      "status": "succeeded",
      "workflow_version": 3,
      "attempt_count": 1,
      "error_code": null,
      "error_message": null,
      "steps_count": 1,
      "succeeded_steps": 1,
      "failed_steps": 0,
      "skipped_steps": 0,
      "started_at": "2026-08-27T10:20:00.120Z",
      "finished_at": "2026-08-27T10:20:00.810Z",
      "created_at": "2026-08-27T10:20:00.000Z",
      "updated_at": "2026-08-27T10:20:00.810Z"
    }
  ]
}

Retrieve a workflow run input parameters

Retrieve a workflow run accepts the route, header, query, and body inputs listed below.

Retrieve a workflow run path parameters

idstringRequired

Workflow ID. Used by the Retrieve a workflow run operation.

runIdstringRequired

Workflow run ID. Used by the Retrieve a workflow run operation.

Retrieve a workflow run query parameters

include_datastringOptional

false by default; true includes redacted Trigger and output previews when available Used by the Retrieve a workflow run operation.

Retrieve a workflow run notes

Sensitive fields are redacted from data previews.
Large, expired, or unavailable payloads return preview metadata instead of the stored value.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/workflows/wfl_01jv8d2m7q4r9x3p6n5k1s0t8b/runs/wfr_01jv8d5p3x7r2q9m6n4k1s0t8b?include_data=example" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "id": "wfr_01jv8d5p3x7r2q9m6n4k1s0t8b",
  "workflow_id": "wfl_01jv8d2m7q4r9x3p6n5k1s0t8b",
  "source_id": "src_q6z62b6py5o79b",
  "request_id": "req_01jv8c3m7b2p4q9x6r5t1n0k8s",
  "status": "succeeded",
  "attempt_count": 1,
  "error_code": null,
  "error_message": null,
  "version": {
    "number": 3,
    "name": "Notify the team about new orders",
    "source_id": "src_q6z62b6py5o79b",
    "graph_sha256": "e927a5d7015744887a9e2a218a9b9fd0",
    "exact": true,
    "snapshot_status": "exact",
    "created_at": "2026-08-27T10:15:00.000Z"
  },
  "trigger": { "preview_included": false },
  "steps": [
    {
      "step_id": "wfs_notify_slack",
      "name": "Send Slack message",
      "kind": "action",
      "status": "succeeded",
      "execution_index": 0,
      "output_port": "success",
      "response_status": 200,
      "error_code": null,
      "output": {
        "available": true,
        "sha256": "8db90d4b69b5dbedbc7fbcd4c64f33dc",
        "size_bytes": 184
      }
    }
  ]
}

List workflow activity input parameters

List workflow activity accepts the route, header, query, and body inputs listed below.

List workflow activity query parameters

limitintegerOptional

defaults to 100, max 100 Used by the List workflow activity operation.

fromdatetimeOptional

ISO timestamp, now, or relative time such as now-24h Used by the List workflow activity operation.

todatetimeOptional

ISO timestamp, now, or relative time such as now-15m Used by the List workflow activity operation.

source_idstringOptional

optional Source filter Used by the List workflow activity operation.

statusenumOptional

queued | running | succeeded | failed Used by the List workflow activity operation.

qstringOptional

searches request ID, Workflow name, or Source name; max 200 characters Used by the List workflow activity operation.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/workflow-activity?limit=100&from=2026-04-17T00%3A00%3A00.000Z&to=2026-04-17T23%3A59%3A59.999Z&source_id=src_q6z62b6py5o79b&status=enabled&q=stripe" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "total": 1,
  "count": 1,
  "models": [
    {
      "id": "wfr_01jv8d5p3x7r2q9m6n4k1s0t8b",
      "request_id": "req_01jv8c3m7b2p4q9x6r5t1n0k8s",
      "workflow_id": "wfl_01jv8d2m7q4r9x3p6n5k1s0t8b",
      "workflow_name": "Notify the team about new orders",
      "workflow_version": 3,
      "source": {
        "id": "src_q6z62b6py5o79b",
        "name": "New orders",
        "provider_key": null,
        "trigger_name": "New orders"
      },
      "status": "succeeded",
      "steps_count": 1,
      "succeeded_steps": 1,
      "failed_steps": 0,
      "skipped_steps": 0,
      "steps": [
        {
          "step_id": "wfs_notify_slack",
          "name": "Send Slack message",
          "kind": "action",
          "status": "succeeded",
          "execution_index": 0,
          "output_port": "success",
          "response_status": 200
        }
      ]
    }
  ]
}

Sources

Sources are ingress endpoints. External systems send HTTP requests to source URLs.

Sources response fields

16 fields

idsrc_*

Unique source ID. Source IDs use the src_ prefix.

team_id

Team that owns the source.

name

Human-readable source name, unique within the team.

description

Optional description for operators and API clients.

typeWEBHOOK or vendor-specific

Source implementation type, usually WEBHOOK for public ingress endpoints.

config.auth_type

Verification mode applied to inbound webhook requests.

config.auth

Authentication or verification settings for the selected auth type.

config.custom_response

Optional static or rule-based dynamic response FastHook returns to the sender after accepting a source request.

config.discord_defer_ephemeral

DISCORD source setting. When true, FastHook sets the EPHEMERAL flag on the automatic initial defer so follow-up responses remain private.

config.mode

Source runtime mode. webhook is normal queued source behavior; proxy forwards the source request to an upstream API and returns the upstream response.

config.proxy

Proxy mode settings for target URL, path/query forwarding, timeout, response body capture, and allowed methods.

config.allowed_http_methods

HTTP methods accepted by the source endpoint.

url

Public URL that external systems use to send webhooks to this source.

disabled_at

ISO timestamp when the source was disabled, or null when active.

created_at

ISO timestamp when the source was created.

updated_at

ISO timestamp when the source was last changed.

Sources shared request body fields

namestringRequired

required when creating or upserting; optional when updating

descriptionstringOptional

optional string or null

typestringOptional

optional source type, defaults to WEBHOOK

statusenumOptional

optional enabled | disabled

url or config.urlstringOptional

optional source URL

config.auth_typeenumOptional

BASIC_AUTH | API_KEY | HMAC | null

config.authstringOptional

auth settings for auth_type

config.custom_responseobjectOptional

optional object or null

config.custom_response.content_typeenumOptional

json | text | xml

config.custom_response.bodystringOptional

optional fallback response body string

config.custom_response.rulesarrayOptional

optional ordered dynamic response rules array

config.custom_response.rules[].enabledbooleanOptional

optional boolean, false skips the rule

config.custom_response.rules[].matchstringOptional

optional method/path/query/headers/body matcher

config.custom_response.rules[].responsestringOptional

optional status/content_type/body/headers response override

config.discord_defer_ephemeralbooleanOptional

optional boolean for DISCORD sources; adds EPHEMERAL flags to the initial defer response

config.modeenumOptional

optional webhook | proxy; proxy makes the source return the upstream response to the original caller

config.proxy.enabledstringOptional

true enables proxy mode

config.proxy.target_urlstringRequired

required absolute http(s) upstream URL for proxy sources

config.proxy.path_forwardingbooleanOptional

optional boolean, defaults to true; appends the inbound request path to target_url

config.proxy.query_forwardingbooleanOptional

optional boolean, defaults to true; appends inbound query params to target_url

config.proxy.timeout_msintegerOptional

optional 1000-30000 upstream timeout in milliseconds

config.proxy.response_capture_limit_bytesintegerOptional

optional 0-65536 bytes stored in request trace

Proxy targets cannot use localhost, private IP ranges, link-local ranges, loopback, credentials in the URL, or Cloudflare metadata hosts

stringOptional

Request parameter.

config.allowed_http_methodsarrayOptional

List sources input parameters

List sources accepts the route, header, query, and body inputs listed below.

List sources query parameters

idstringOptional

optional ID filter, comma-separated or repeated Used by the List sources operation.

namestringOptional

optional exact name filter Used by the List sources operation.

typestringOptional

optional resource type filter Used by the List sources operation.

disabledstringOptional

false excludes disabled resources Used by the List sources operation.

order_byenumOptional

name | created_at | updated_at Used by the List sources operation.

direnumOptional

asc | desc Used by the List sources operation.

limitintegerOptional

max 255 Used by the List sources operation.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/sources?id=src_q6z62b6py5o79b&name=Stripe&type=WEBHOOK&disabled=false&order_by=created_at&dir=desc&limit=100" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "pagination": {
    "order_by": "created_at",
    "dir": "desc",
    "limit": 100
  },
  "count": 1,
  "models": [
    {
      "id": "src_q6z62b6py5o79b",
      "team_id": "tm_3b5335b627084a838b",
      "updated_at": "2026-01-14T13:36:41.583Z",
      "created_at": "2026-01-14T13:35:55.226Z",
      "name": "stripe-production",
      "type": "WEBHOOK",
      "description": "Stripe billing webhook source",
      "url": "https://hook-xxxxxx.fasthook.io/",
      "config": {
        "auth_type": "BASIC_AUTH",
        "auth": {
          "username": "stripe-webhook",
          "password": "secret-password"
        },
        "custom_response": {
          "content_type": "json",
          "body": "{\"received\":true}",
          "rules": [
            {
              "name": "create order mock",
              "match": {
                "method": "POST",
                "path": "/orders",
                "body": {
                  "type": "order.created"
                }
              },
              "response": {
                "status": 201,
                "content_type": "json",
                "headers": {
                  "x-mock-rule": "create-order"
                },
                "body": "{\"ok\":true,\"request_id\":\"{{request.id}}\"}"
              }
            }
          ]
        },
        "allowed_http_methods": ["POST", "PUT", "PATCH", "DELETE"]
      },
      "disabled_at": null
    }
  ]
}

Retrieve a source input parameters

Retrieve a source accepts the route, header, query, and body inputs listed below.

Retrieve a source path parameters

idstringRequired

Source ID. Used by the Retrieve a source operation.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/sources/src_q6z62b6py5o79b" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "id": "src_q6z62b6py5o79b",
  "team_id": "tm_3b5335b627084a838b",
  "updated_at": "2026-01-14T13:36:41.583Z",
  "created_at": "2026-01-14T13:35:55.226Z",
  "name": "Stripe",
  "description": "Stripe billing webhook source",
  "type": "WEBHOOK",
  "url": "https://hook-xxxxxx.fasthook.io/",
  "config": {
    "auth_type": "BASIC_AUTH",
    "auth": {
      "username": "stripe-webhook",
      "password": "secret-password"
    },
    "custom_response": {
      "content_type": "json",
      "body": "{\"received\":true}"
    },
    "allowed_http_methods": ["POST", "PUT", "PATCH", "DELETE"]
  },
  "disabled_at": null
}

Create a source input parameters

Create a source uses the shared request body fields above together with any route, header, or query inputs listed here.

Create a source notes

Duplicate create returns 409 with RESOURCE_ALREADY_EXISTS.
custom_response.rules are evaluated before the fallback body; the first enabled matching rule wins.
custom_response.body and custom_response.rules can be used together; body is the fallback when no enabled rule matches.
Dynamic response rules support $eq, $ne, $contains, $starts_with, $ends_with, $exists, $in, and $regex operators.
status defaults to enabled. Send status only when creating a disabled source.
description is optional metadata for operators and API clients.

Request

Shell

curl -X POST \
  "https://api.fasthook.io/v1/sources" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "name": "Stripe",
  "type": "WEBHOOK",
  "url": "https://hook-xxxxxx.fasthook.io/",
  "config": {
    "auth_type": "BASIC_AUTH",
    "auth": {
      "username": "stripe-webhook",
      "password": "secret-password"
    },
    "custom_response": {
      "content_type": "json",
      "body": "{\"received\":true}"
    },
    "mode": "webhook",
    "proxy": null,
    "allowed_http_methods": ["POST", "PUT", "PATCH", "DELETE"]
  }
}'

Response

JSON

{
  "id": "src_q6z62b6py5o79b",
  "team_id": "tm_3b5335b627084a838b",
  "name": "Stripe",
  "type": "WEBHOOK",
  "description": null,
  "url": "https://hook-xxxxxx.fasthook.io/",
  "config": {
    "auth_type": "BASIC_AUTH",
    "auth": {
      "username": "stripe-webhook",
      "password": "secret-password"
    },
    "custom_response": {
      "content_type": "json",
      "body": "{\"received\":true}"
    },
    "mode": "webhook",
    "proxy": null,
    "allowed_http_methods": ["POST", "PUT", "PATCH", "DELETE"]
  },
  "disabled_at": null,
  "created_at": "2026-01-14T13:35:55.226Z",
  "updated_at": "2026-01-14T13:35:55.226Z"
}

Upsert a source input parameters

Upsert a source uses the shared request body fields above together with any route, header, or query inputs listed here.

Request

Shell

curl -X PUT \
  "https://api.fasthook.io/v1/sources" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "name": "Stripe",
  "description": "Stripe billing webhook source",
  "type": "WEBHOOK",
  "status": "enabled",
  "url": "https://hook-xxxxxx.fasthook.io/",
  "config": {
    "auth_type": "BASIC_AUTH",
    "auth": {
      "username": "stripe-webhook",
      "password": "secret-password"
    },
    "custom_response": {
      "content_type": "json",
      "body": "{\"received\":true}"
    },
    "mode": "webhook",
    "proxy": null,
    "allowed_http_methods": ["POST", "PUT", "PATCH", "DELETE"]
  }
}'

Response

JSON

{
  "id": "src_q6z62b6py5o79b",
  "team_id": "tm_3b5335b627084a838b",
  "name": "Stripe",
  "type": "WEBHOOK",
  "description": "Stripe billing webhook source",
  "url": "https://hook-xxxxxx.fasthook.io/",
  "config": {
    "auth_type": "BASIC_AUTH",
    "auth": {
      "username": "stripe-webhook",
      "password": "secret-password"
    },
    "custom_response": {
      "content_type": "json",
      "body": "{\"received\":true}"
    },
    "allowed_http_methods": ["POST", "PUT", "PATCH", "DELETE"]
  },
  "disabled_at": null,
  "created_at": "2026-01-14T13:35:55.226Z",
  "updated_at": "2026-01-14T13:36:41.583Z"
}

Update a source input parameters

Update a source uses the shared request body fields above together with any route, header, or query inputs listed here.

Update a source path parameters

idstringRequired

Source ID. Used by the Update a source operation.

Request

Shell

curl -X PUT \
  "https://api.fasthook.io/v1/sources/src_q6z62b6py5o79b" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "name": "Stripe production",
  "description": "Stripe billing webhook source",
  "type": "WEBHOOK",
  "status": "enabled",
  "url": "https://hook-xxxxxx.fasthook.io/",
  "config": {
    "auth_type": "BASIC_AUTH",
    "auth": {
      "username": "stripe-webhook",
      "password": "secret-password"
    },
    "custom_response": {
      "content_type": "json",
      "body": "{\"received\":true}"
    },
    "mode": "webhook",
    "proxy": null,
    "allowed_http_methods": ["POST", "PUT", "PATCH", "DELETE"]
  }
}'

Response

JSON

{
  "id": "src_q6z62b6py5o79b",
  "team_id": "tm_3b5335b627084a838b",
  "name": "Stripe production",
  "type": "WEBHOOK",
  "description": "Stripe billing webhook source",
  "url": "https://hook-xxxxxx.fasthook.io/",
  "config": {
    "auth_type": "BASIC_AUTH",
    "auth": {
      "username": "stripe-webhook",
      "password": "secret-password"
    },
    "custom_response": {
      "content_type": "json",
      "body": "{\"received\":true}"
    },
    "mode": "webhook",
    "proxy": null,
    "allowed_http_methods": ["POST", "PUT", "PATCH", "DELETE"]
  },
  "disabled_at": null,
  "created_at": "2026-01-14T13:35:55.226Z",
  "updated_at": "2026-01-14T13:37:12.104Z"
}

Disable a source input parameters

Disable a source accepts the route, header, query, and body inputs listed below.

Disable a source path parameters

idstringRequired

Source ID. Used by the Disable a source operation.

Disable a source notes

Both PUT and POST are accepted for this action.

Request

Shell

curl -X POST \
  "https://api.fasthook.io/v1/sources/src_q6z62b6py5o79b/disable" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "id": "src_q6z62b6py5o79b",
  "team_id": "tm_3b5335b627084a838b",
  "name": "Stripe production",
  "description": "Stripe billing webhook source",
  "type": "WEBHOOK",
  "url": "https://hook-xxxxxx.fasthook.io/",
  "config": {
    "auth_type": "BASIC_AUTH",
    "auth": {
      "username": "stripe-webhook",
      "password": "secret-password"
    },
    "custom_response": {
      "content_type": "json",
      "body": "{\"received\":true}"
    },
    "allowed_http_methods": ["POST", "PUT", "PATCH", "DELETE"]
  },
  "disabled_at": "2026-05-10T18:00:00.000Z",
  "created_at": "2026-01-14T13:35:55.226Z",
  "updated_at": "2026-05-10T18:00:00.000Z"
}

Enable a source input parameters

Enable a source accepts the route, header, query, and body inputs listed below.

Enable a source path parameters

idstringRequired

Source ID. Used by the Enable a source operation.

Enable a source notes

Both PUT and POST are accepted for this action.

Request

Shell

curl -X POST \
  "https://api.fasthook.io/v1/sources/src_q6z62b6py5o79b/enable" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "id": "src_q6z62b6py5o79b",
  "team_id": "tm_3b5335b627084a838b",
  "name": "Stripe production",
  "description": "Stripe billing webhook source",
  "type": "WEBHOOK",
  "url": "https://hook-xxxxxx.fasthook.io/",
  "config": {
    "auth_type": "BASIC_AUTH",
    "auth": {
      "username": "stripe-webhook",
      "password": "secret-password"
    },
    "custom_response": {
      "content_type": "json",
      "body": "{\"received\":true}"
    },
    "allowed_http_methods": ["POST", "PUT", "PATCH", "DELETE"]
  },
  "disabled_at": null,
  "created_at": "2026-01-14T13:35:55.226Z",
  "updated_at": "2026-05-10T18:02:15.441Z"
}

List Instant Trigger channels input parameters

List Instant Trigger channels accepts the route, header, query, and body inputs listed below.

List Instant Trigger channels query parameters

statusenumOptional

optional connecting | active | expiring | error | fallback filter Used by the List Instant Trigger channels operation.

List Instant Trigger channels notes

The channel status is derived from expected targets, active subscriptions, expiration, runtime fallback, provider-account errors, and active provision or renewal alerts.
The embedded metrics_48h object summarizes the current and previous UTC date.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/sources/channels?status=enabled" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "models": [
    {
      "id": "src_google_drive_changes",
      "source_id": "src_google_drive_changes",
      "name": "Drive changes",
      "provider_key": "google_drive",
      "definition_key": "google_drive.new_or_modified_files.instant",
      "status": "enabled",
      "delivery_mode": "instant",
      "channel": {
        "status": "active",
        "expected_targets": 1,
        "active_targets": 1,
        "pending_targets": 0,
        "expiration_at": "2026-08-28T10:00:00.000Z",
        "last_error": null,
        "failure_count": 0,
        "next_retry_at": null,
        "runtime_mode": "instant",
        "auto_fallback": true,
        "max_failures": 3,
        "restore_after_minutes": 30,
        "active_alerts": 0
      }
    }
  ]
}

List Instant Trigger channel alerts input parameters

List Instant Trigger channel alerts accepts the route, header, query, and body inputs listed below.

List Instant Trigger channel alerts query parameters

statusenumOptional

active by default; resolved | all Used by the List Instant Trigger channel alerts operation.

limitintegerOptional

defaults to 50, max 100 Used by the List Instant Trigger channel alerts operation.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/sources/channel-alerts?status=enabled&limit=100" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "models": [
    {
      "id": "tca_4cc35e88",
      "source_id": "src_google_drive_changes",
      "source_name": "Drive changes",
      "provider_key": "google_drive",
      "definition_key": "google_drive.new_or_modified_files.instant",
      "code": "channel_renew_failed",
      "status": "active",
      "message": "Provider channel renewal failed",
      "occurrences": 2,
      "first_seen_at": "2026-08-27T09:00:00.000Z",
      "last_seen_at": "2026-08-27T10:00:00.000Z",
      "resolved_at": null
    }
  ]
}

List Instant Trigger channel metrics input parameters

List Instant Trigger channel metrics accepts the route, header, query, and body inputs listed below.

List Instant Trigger channel metrics query parameters

daysstringOptional

defaults to 14, min 1, max 90 Used by the List Instant Trigger channel metrics operation.

List Instant Trigger channel metrics notes

Metric values are counters; notification_latency_ms is an accumulated latency value used to calculate an average in the per-Source channel model.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/sources/channel-metrics?days=example" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "series": [
    { "metric_date": "2026-08-27", "metric": "notification_received", "value": 42 },
    { "metric_date": "2026-08-27", "metric": "notification_queued", "value": 42 },
    { "metric_date": "2026-08-27", "metric": "notification_latency_ms", "value": 1680 }
  ]
}

Read channel alert settings input parameters

Read channel alert settings does not require path, query, or body parameters.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/sources/channel-settings" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "email_enabled": true,
  "slack_enabled": false,
  "slack_configured": false,
  "cooldown_minutes": 60,
  "silence_alert_hours": 24,
  "updated_at": null
}

Update channel alert settings input parameters

Update channel alert settings uses the shared request body fields above together with any route, header, or query inputs listed here.

Update channel alert settings notes

The Slack webhook is encrypted and is never returned by this endpoint.

Request

Shell

curl -X PATCH \
  "https://api.fasthook.io/v1/sources/channel-settings" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "email_enabled": true,
  "slack_enabled": true,
  "slack_webhook_url": "https://hooks.slack.com/services/T000/B000/REDACTED",
  "cooldown_minutes": 60,
  "silence_alert_hours": 24
}'

Response

JSON

{
  "email_enabled": true,
  "slack_enabled": true,
  "slack_configured": true,
  "cooldown_minutes": 60,
  "silence_alert_hours": 24,
  "updated_at": "2026-08-27T10:00:00.000Z"
}

Retry an Instant Trigger channel input parameters

Retry an Instant Trigger channel accepts the route, header, query, and body inputs listed below.

Retry an Instant Trigger channel path parameters

idstringRequired

Source ID. Used by the Retry an Instant Trigger channel operation.

Retry an Instant Trigger channel notes

Returns 202 when accepted.
Returns 409 for a polling Source, disabled Source, or Source without a connected account.

Request

Shell

curl -X POST \
  "https://api.fasthook.io/v1/sources/src_q6z62b6py5o79b/channel-retry" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "source_id": "src_google_drive_changes",
  "status": "connecting",
  "retry_requested_at": "2026-08-27T10:05:00.000Z"
}

List Instant Trigger channel events input parameters

List Instant Trigger channel events accepts the route, header, query, and body inputs listed below.

List Instant Trigger channel events path parameters

idstringRequired

Source ID. Used by the List Instant Trigger channel events operation.

List Instant Trigger channel events query parameters

limitintegerOptional

defaults to 100, max 200 Used by the List Instant Trigger channel events operation.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/sources/src_q6z62b6py5o79b/channel-events?limit=100" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "events": [
    {
      "id": "tce_903d7c",
      "event_type": "channel_renewed",
      "message": null,
      "detail": {
        "target_id": "drive_123",
        "expiration_at": "2026-08-28T10:00:00.000Z"
      },
      "created_at": "2026-08-27T10:00:00.000Z"
    }
  ],
  "channels": [],
  "deliveries": [
    {
      "id": "tcd_b753f0",
      "alert_id": "tca_4cc35e88",
      "transport": "email",
      "status": "sent",
      "error_message": null,
      "created_at": "2026-08-27T09:00:00.000Z"
    }
  ]
}

Change provider Trigger delivery mode input parameters

Change provider Trigger delivery mode uses the shared request body fields above together with any route, header, or query inputs listed here.

Change provider Trigger delivery mode path parameters

idstringRequired

Source ID. Used by the Change provider Trigger delivery mode operation.

Change provider Trigger delivery mode notes

Returns 409 when the Source type has no matching delivery definition.

Request

Shell

curl -X PATCH \
  "https://api.fasthook.io/v1/sources/src_q6z62b6py5o79b/delivery" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "delivery_mode": "instant",
  "auto_fallback": true,
  "max_failures": 3,
  "restore_after_minutes": 30
}'

Response

JSON

{
  "id": "src_google_drive_changes",
  "name": "Drive changes",
  "status": "enabled",
  "delivery_mode": "instant",
  "channel": {
    "status": "connecting",
    "auto_fallback": true,
    "max_failures": 3,
    "restore_after_minutes": 30
  }
}

Bulk retry or change Trigger delivery input parameters

Bulk retry or change Trigger delivery uses the shared request body fields above together with any route, header, or query inputs listed here.

Bulk retry or change Trigger delivery notes

Unsupported delivery definitions are returned in errors without preventing other selected Sources from being processed.

Request

Shell

curl -X POST \
  "https://api.fasthook.io/v1/sources/channels/bulk" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "source_ids": ["src_google_drive_changes"],
  "action": "retry"
}'

Response

JSON

{
  "updated": 1,
  "errors": []
}

Delete a source input parameters

Delete a source accepts the route, header, query, and body inputs listed below.

Delete a source path parameters

idstringRequired

Source ID. Used by the Delete a source operation.

Request

Shell

curl -X DELETE \
  "https://api.fasthook.io/v1/sources/src_q6z62b6py5o79b" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "id": "src_q6z62b6py5o79b"
}

Destinations

Destinations are outbound endpoints that receive routed events.

Destinations response fields

21 fields

iddes_*

Unique destination ID. Destination IDs use the des_ prefix.

team_id

Team that owns the destination.

name

Human-readable destination name, unique within the team.

description

Optional description for operators and API clients.

Destination implementation type: HTTP, CLI, POSTGRESQL, SENDGRID_EMAIL, CLOUDFLARE_R2, or AWS_S3.

config.url, config.path, or type-specific config

HTTP delivery URL, CLI path, PostgreSQL table settings, SendGrid email settings, Cloudflare R2 archive settings, or AWS S3 archive settings.

config.rate_limit

Optional delivery rate limit for this destination.

config.rate_limit_period

Time window used by the destination rate limit.

config.http_method

HTTP method used when delivering events to the destination.

config.path_forwarding_disabled

Whether inbound request paths are omitted from forwarded delivery URLs.

config.auth_type

Authentication mode used for outbound deliveries: null/NO_AUTH, FASTHOOK_SIGNATURE, CUSTOM_HEADER, OAUTH2_CLIENT_CREDENTIALS, OAUTH2_AUTHORIZATION_CODE, GOOGLE_OAUTH_REFRESH_TOKEN, POSTGRES_PASSWORD, SENDGRID_API_KEY, R2_ACCESS_KEY, or AWS_ACCESS_KEY.

config.auth

Outbound authentication settings for the selected destination auth type, including OAuth2 token credentials for HTTP destinations.

config.columns

Optional ordered list of dotted payload or metadata paths to write into sheet columns.

config.include_metadata

Whether default metadata is written for CLOUDFLARE_R2 and AWS_S3 destinations when explicit output fields are not configured.

config.key_template

Object key template for CLOUDFLARE_R2 and AWS_S3 destinations.

config.content_type

Object media type for CLOUDFLARE_R2 and AWS_S3 destinations.

disabled_at

ISO timestamp when the destination was disabled, or null when active.

attempts_24h_count

Total delivery attempts recorded for this destination in the last 24 hours.

attempts_24h_bins

Recent delivery-attempt histogram for the destination.

created_at

ISO timestamp when the destination was created.

updated_at

ISO timestamp when the destination was last changed.

Destinations shared request body fields

namestringRequired

required when creating, upserting, or replacing; optional when patching

descriptionstringOptional

optional string or null

typeenumOptional

config targetstringRequired

required when creating, upserting, or replacing; optional when patching

config.rate_limitintegerOptional

optional positive integer or null

config.rate_limit_periodenumOptional

second | minute | hour | day

config.http_methodenumOptional

POST | PUT | PATCH | DELETE

config.path_forwarding_disabledbooleanOptional

boolean

config.auth_typeenumOptional

config.authstringOptional

destination auth settings

config.auth_type null/NO_AUTHstringOptional

disables outbound auth

config.auth.header_name/valuestringRequired

required for CUSTOM_HEADER

config.auth.token_url/client_id/client_secretstringRequired

required for OAUTH2_CLIENT_CREDENTIALS

config.auth.auth_url/token_url/client_id/client_secret/refresh_tokenstringRequired

required for OAUTH2_AUTHORIZATION_CODE

config.auth.client_auth_methodenumOptional

client_secret_post | client_secret_basic

config.auth.client_id/client_secret/refresh_tokenstringRequired

required for GOOGLE_OAUTH_REFRESH_TOKEN

config.auth.api_keystringRequired

required for SENDGRID_API_KEY

config.auth.scopestringOptional

optional for OAuth2 auth types and GOOGLE_OAUTH_REFRESH_TOKEN

config.auth.redirect_uristringOptional

optional for OAUTH2_AUTHORIZATION_CODE

config.auth.audience, config.auth.authorization_params, config.auth.token_paramsstringOptional

optional for OAuth2 auth types

config.host/config.port/config.databasestringRequired

required PostgreSQL endpoint; port defaults to 5432

config.schema/config.tablestringOptional

target PostgreSQL schema and table; schema defaults to public

config.payload_columnstringRequired

required JSONB target column, defaults to payload

config.event_id_columnstringOptional

optional text column for FastHook event IDs and idempotency

config.metadata_columnstringOptional

optional JSONB column for FastHook delivery metadata

config.delivered_at_columnstringOptional

optional timestamptz delivery-time column

config.on_conflictenumOptional

ERROR | IGNORE; IGNORE requires event_id_column and a matching UNIQUE constraint

config.ssl_modeenumOptional

verify-full | disable; defaults to verify-full

config.connect_timeout_secondsintegerOptional

integer from 1 to 30, defaults to 10

config.auth_typestringOptional

POSTGRES_PASSWORD for POSTGRESQL

config.auth.username/config.auth.passwordstringRequired

required PostgreSQL credentials

POSTGRESQL targets must be publicly reachable; FastHook does not create or migrate the tablestringOptional

Request parameter.

config.fromstringRequired

required for SENDGRID_EMAIL; verified SendGrid sender email or authenticated domain address; fasthook.io sender domains are admin-only

config.from_namestringOptional

optional display name for SENDGRID_EMAIL

config.toarrayRequired

required for SENDGRID_EMAIL; string or array of recipient templates

config.cc/config.bcc/config.reply_tostringOptional

optional for SENDGRID_EMAIL

config.subjectstringOptional

optional for SENDGRID_EMAIL, defaults to FastHook event {{event_id}}

config.text_template/config.html_templatestringOptional

optional for SENDGRID_EMAIL

config.api_base_urlstringOptional

optional for SENDGRID_EMAIL; https://api.sendgrid.com or https://api.eu.sendgrid.com

config.auth_typestringOptional

SENDGRID_API_KEY for SENDGRID_EMAIL

config.auth.api_keystringRequired

required SG... SendGrid API key for SENDGRID_EMAIL

SENDGRID_EMAIL accepts at most 10 total To, Cc, and Bcc recipients after template renderingstringOptional

Request parameter.

config.account_idstringRequired

required for CLOUDFLARE_R2; client Cloudflare account ID

config.endpointstringOptional

optional for CLOUDFLARE_R2; defaults to https://<account_id>.r2.cloudflarestorage.com

config.bucketstringRequired

required for CLOUDFLARE_R2; client R2 bucket name

config.key_templateobjectRequired

required for CLOUDFLARE_R2; R2 object key template, defaults to archives/{{team_id}}/{{source_id}}/{{event_id}}.json

config.content_typeobjectOptional

optional for CLOUDFLARE_R2; object media type, defaults to application/json

config.body_templatestringOptional

optional for CLOUDFLARE_R2; rendered archive body, otherwise FastHook stores metadata plus payload JSON

config.include_metadatabooleanOptional

optional boolean for CLOUDFLARE_R2 envelope mode

config.auth_typestringRequired

required for CLOUDFLARE_R2; use R2_ACCESS_KEY

config.auth.access_key_id/config.auth.secret_access_keystringRequired

required R2 S3 API credentials

config.auth.session_tokenstringOptional

optional temporary credential token

config.regionstringRequired

required for AWS_S3; AWS region used for SigV4 signing, such as eu-central-1

config.endpointstringOptional

optional for AWS_S3; defaults to https://s3.<region>.amazonaws.com

config.bucketstringRequired

required for AWS_S3; client S3 bucket name

config.force_path_stylebooleanOptional

optional boolean for AWS_S3 path-style S3 URLs

config.key_templateobjectRequired

required for AWS_S3; S3 object key template, defaults to archives/{{team_id}}/{{source_id}}/{{event_id}}.json

config.content_typeobjectOptional

optional for AWS_S3; object media type, defaults to application/json

config.body_templatestringOptional

optional for AWS_S3; rendered archive body, otherwise FastHook stores metadata plus payload JSON

config.include_metadatabooleanOptional

optional boolean for AWS_S3 envelope mode

config.auth_typestringRequired

required for AWS_S3; use AWS_ACCESS_KEY

config.auth.access_key_id/config.auth.secret_access_keyobjectRequired

required AWS credentials with s3:PutObject permission

config.auth.session_tokenstringOptional

optional temporary AWS session token

List destinations input parameters

List destinations accepts the route, header, query, and body inputs listed below.

List destinations query parameters

idstringOptional

optional ID filter, comma-separated or repeated Used by the List destinations operation.

namestringOptional

optional exact name filter Used by the List destinations operation.

typestringOptional

optional resource type filter Used by the List destinations operation.

disabledstringOptional

false excludes disabled resources Used by the List destinations operation.

order_byenumOptional

name | created_at | updated_at Used by the List destinations operation.

direnumOptional

asc | desc Used by the List destinations operation.

limitintegerOptional

max 255 Used by the List destinations operation.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/destinations?id=des_TU9ioCk5EHUU&name=Production+API&type=HTTP&disabled=false&order_by=created_at&dir=desc&limit=100" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "pagination": {
    "order_by": "created_at",
    "dir": "desc",
    "limit": 100
  },
  "count": 1,
  "models": [
    {
      "id": "des_TU9ioCk5EHUU",
      "team_id": "tm_3b5335b627084a838b",
      "updated_at": "2026-01-14T13:36:41.584Z",
      "created_at": "2026-01-14T13:35:55.263Z",
      "name": "production-api",
      "type": "HTTP",
      "description": "Primary billing event consumer",
      "config": {
        "url": "https://api.example.com/webhooks",
        "path": null,
        "rate_limit": null,
        "rate_limit_period": "second",
        "http_method": "POST",
        "path_forwarding_disabled": false,
        "auth": {},
        "auth_type": "FASTHOOK_SIGNATURE"
      },
      "disabled_at": null,
      "attempts_24h_count": 12,
      "attempts_24h_bins": [0, 0, 2, 5, 3, 2]
    }
  ]
}

Retrieve a destination input parameters

Retrieve a destination accepts the route, header, query, and body inputs listed below.

Retrieve a destination path parameters

idstringRequired

Destination ID. Used by the Retrieve a destination operation.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/destinations/des_TU9ioCk5EHUU" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "id": "des_TU9ioCk5EHUU",
  "team_id": "tm_3b5335b627084a838b",
  "updated_at": "2026-01-14T13:36:41.584Z",
  "created_at": "2026-01-14T13:35:55.263Z",
  "name": "Production API",
  "type": "HTTP",
  "description": "Primary billing event consumer",
  "config": {
    "url": "https://api.example.com/webhooks",
    "path": null,
    "rate_limit": null,
    "rate_limit_period": "second",
    "http_method": "POST",
    "path_forwarding_disabled": false,
    "auth_type": "FASTHOOK_SIGNATURE",
    "auth": {}
  },
  "disabled_at": null,
  "attempts_24h_count": 12,
  "attempts_24h_bins": [0, 0, 2, 5, 3, 2]
}

Create a destination input parameters

Create a destination uses the shared request body fields above together with any route, header, or query inputs listed here.

Request

Shell

curl -X POST \
  "https://api.fasthook.io/v1/destinations" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "name": "Production API",
  "description": "Primary billing event consumer",
  "type": "HTTP",
  "config": {
    "url": "https://api.example.com/webhooks",
    "path": null,
    "rate_limit": 60,
    "rate_limit_period": "minute",
    "http_method": "POST",
    "path_forwarding_disabled": false,
    "auth_type": "FASTHOOK_SIGNATURE",
    "auth": {}
  }
}'

Response

JSON

{
  "id": "des_TU9ioCk5EHUU",
  "team_id": "tm_3b5335b627084a838b",
  "name": "Production API",
  "type": "HTTP",
  "description": "Primary billing event consumer",
  "config": {
    "url": "https://api.example.com/webhooks",
    "path": null,
    "rate_limit": 60,
    "rate_limit_period": "minute",
    "http_method": "POST",
    "path_forwarding_disabled": false,
    "auth": {},
    "auth_type": "FASTHOOK_SIGNATURE"
  },
  "disabled_at": null,
  "created_at": "2026-01-14T13:35:55.263Z",
  "updated_at": "2026-01-14T13:35:55.263Z",
  "attempts_24h_count": 0,
  "attempts_24h_bins": [0, 0, 0, 0, 0, 0]
}

Upsert a destination input parameters

Upsert a destination uses the shared request body fields above together with any route, header, or query inputs listed here.

Request

Shell

curl -X PUT \
  "https://api.fasthook.io/v1/destinations" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "name": "Production API",
  "description": "Primary billing event consumer",
  "type": "HTTP",
  "config": {
    "url": "https://api.example.com/webhooks",
    "path": null,
    "rate_limit": 60,
    "rate_limit_period": "minute",
    "http_method": "POST",
    "path_forwarding_disabled": false,
    "auth_type": "FASTHOOK_SIGNATURE",
    "auth": {}
  }
}'

Response

JSON

{
  "id": "des_TU9ioCk5EHUU",
  "team_id": "tm_3b5335b627084a838b",
  "name": "Production API",
  "type": "HTTP",
  "description": "Primary billing event consumer",
  "config": {
    "url": "https://api.example.com/webhooks",
    "path": null,
    "rate_limit": 60,
    "rate_limit_period": "minute",
    "http_method": "POST",
    "path_forwarding_disabled": false,
    "auth": {},
    "auth_type": "FASTHOOK_SIGNATURE"
  },
  "disabled_at": null,
  "created_at": "2026-01-14T13:35:55.263Z",
  "updated_at": "2026-01-14T13:36:41.584Z",
  "attempts_24h_count": 12,
  "attempts_24h_bins": [0, 0, 2, 5, 3, 2]
}

Replace a destination input parameters

Replace a destination uses the shared request body fields above together with any route, header, or query inputs listed here.

Replace a destination path parameters

idstringRequired

Destination ID. Used by the Replace a destination operation.

Replace a destination notes

Use PATCH /v1/destinations/:id when you only want to change part of the destination config.

Request

Shell

curl -X PUT \
  "https://api.fasthook.io/v1/destinations/des_TU9ioCk5EHUU" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "name": "Production API",
  "description": "Primary billing event consumer",
  "type": "HTTP",
  "config": {
    "url": "https://api.example.com/webhooks",
    "path": null,
    "rate_limit": 60,
    "rate_limit_period": "minute",
    "http_method": "POST",
    "path_forwarding_disabled": false,
    "auth_type": "FASTHOOK_SIGNATURE",
    "auth": {}
  }
}'

Response

JSON

{
  "id": "des_TU9ioCk5EHUU",
  "team_id": "tm_3b5335b627084a838b",
  "name": "Production API",
  "description": "Primary billing event consumer",
  "type": "HTTP",
  "config": {
    "url": "https://api.example.com/webhooks",
    "path": null,
    "rate_limit": 60,
    "rate_limit_period": "minute",
    "http_method": "POST",
    "path_forwarding_disabled": false,
    "auth": {},
    "auth_type": "FASTHOOK_SIGNATURE"
  },
  "disabled_at": null,
  "created_at": "2026-01-14T13:35:55.263Z",
  "updated_at": "2026-01-14T13:37:18.812Z",
  "attempts_24h_count": 12,
  "attempts_24h_bins": [0, 0, 2, 5, 3, 2]
}

Patch a destination input parameters

Patch a destination uses the shared request body fields above together with any route, header, or query inputs listed here.

Patch a destination path parameters

idstringRequired

Destination ID. Used by the Patch a destination operation.

Patch a destination notes

The CLI command fasthook destinations update uses this endpoint.

Request

Shell

curl -X PATCH \
  "https://api.fasthook.io/v1/destinations/des_TU9ioCk5EHUU" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "config": {
    "rate_limit": 120,
    "rate_limit_period": "minute"
  }
}'

Response

JSON

{
  "id": "des_TU9ioCk5EHUU",
  "team_id": "tm_3b5335b627084a838b",
  "name": "Production API",
  "description": "Primary billing event consumer",
  "type": "HTTP",
  "config": {
    "url": "https://api.example.com/webhooks",
    "path": null,
    "rate_limit": 120,
    "rate_limit_period": "minute",
    "http_method": "POST",
    "path_forwarding_disabled": false,
    "auth": {},
    "auth_type": "FASTHOOK_SIGNATURE"
  },
  "disabled_at": null,
  "created_at": "2026-01-14T13:35:55.263Z",
  "updated_at": "2026-01-14T13:37:18.812Z",
  "attempts_24h_count": 12,
  "attempts_24h_bins": [0, 0, 2, 5, 3, 2]
}

Disable a destination input parameters

Disable a destination accepts the route, header, query, and body inputs listed below.

Disable a destination path parameters

idstringRequired

Destination ID. Used by the Disable a destination operation.

Disable a destination notes

Both PUT and POST are accepted for this action.

Request

Shell

curl -X POST \
  "https://api.fasthook.io/v1/destinations/des_TU9ioCk5EHUU/disable" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "id": "des_TU9ioCk5EHUU",
  "team_id": "tm_3b5335b627084a838b",
  "name": "Production API",
  "description": "Primary billing event consumer",
  "type": "HTTP",
  "config": {
    "url": "https://api.example.com/webhooks",
    "path": null,
    "rate_limit": null,
    "rate_limit_period": "second",
    "http_method": "POST",
    "path_forwarding_disabled": false,
    "auth": {},
    "auth_type": "FASTHOOK_SIGNATURE"
  },
  "disabled_at": "2026-05-10T18:00:00.000Z",
  "created_at": "2026-01-14T13:35:55.263Z",
  "updated_at": "2026-05-10T18:00:00.000Z",
  "attempts_24h_count": 12,
  "attempts_24h_bins": [0, 0, 2, 5, 3, 2]
}

Enable a destination input parameters

Enable a destination accepts the route, header, query, and body inputs listed below.

Enable a destination path parameters

idstringRequired

Destination ID. Used by the Enable a destination operation.

Enable a destination notes

Both PUT and POST are accepted for this action.

Request

Shell

curl -X POST \
  "https://api.fasthook.io/v1/destinations/des_TU9ioCk5EHUU/enable" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "id": "des_TU9ioCk5EHUU",
  "team_id": "tm_3b5335b627084a838b",
  "name": "Production API",
  "description": "Primary billing event consumer",
  "type": "HTTP",
  "config": {
    "url": "https://api.example.com/webhooks",
    "path": null,
    "rate_limit": null,
    "rate_limit_period": "second",
    "http_method": "POST",
    "path_forwarding_disabled": false,
    "auth": {},
    "auth_type": "FASTHOOK_SIGNATURE"
  },
  "disabled_at": null,
  "created_at": "2026-01-14T13:35:55.263Z",
  "updated_at": "2026-05-10T18:02:15.441Z",
  "attempts_24h_count": 12,
  "attempts_24h_bins": [0, 0, 2, 5, 3, 2]
}

Delete a destination input parameters

Delete a destination accepts the route, header, query, and body inputs listed below.

Delete a destination path parameters

idstringRequired

Destination ID. Used by the Delete a destination operation.

Request

Shell

curl -X DELETE \
  "https://api.fasthook.io/v1/destinations/des_TU9ioCk5EHUU" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "id": "des_TU9ioCk5EHUU"
}

Transformations

Transformations are reusable JavaScript snippets that reshape requests before delivery.

Transformations response fields

15 fields

idtrs_*

Unique transformation ID. Transformation IDs use the trs_ prefix.

team_id

Team that owns the transformation.

name

Human-readable transformation name, unique within the team.

code

JavaScript code executed to reshape a webhook request before delivery.

env

Key-value environment variables available to the transformation runtime.

code_hash

Hash of the current transformation code for change detection.

deleted_at

ISO timestamp when the transformation was deleted, or null when active.

executions_24h_count

Number of transformation executions recorded in the last 24 hours.

executions_24h_successful_count

Number of transformation executions without error-level logs in the last 24 hours.

executions_24h_failed_count

Number of transformation executions with error-level logs in the last 24 hours.

executions_24h_successful_bins

Top-level six-bucket history of successful transformation executions during the last 24 hours.

executions_24h_failed_bins

Top-level six-bucket history of failed transformation executions during the last 24 hours.

connections_count

Number of routing connections that reference this transformation.

created_at

ISO timestamp when the transformation was created.

updated_at

ISO timestamp when the transformation was last changed.

List transformations input parameters

List transformations accepts the route, header, query, and body inputs listed below.

List transformations query parameters

idstringOptional

optional ID filter, comma-separated or repeated Used by the List transformations operation.

namestringOptional

optional exact name filter Used by the List transformations operation.

include_metricsstringOptional

true includes legacy execution and connection counts Used by the List transformations operation.

order_byenumOptional

name | created_at | updated_at Used by the List transformations operation.

direnumOptional

asc | desc Used by the List transformations operation.

limitintegerOptional

max 255 Used by the List transformations operation.

List transformations notes

Use GET /v1/metrics/transformations after listing visible transformations to load table counts separately.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/transformations?id=trs_2jYb7sL8mN4pQ9rT&name=Normalize+billing+event&include_metrics=example&order_by=created_at&dir=desc&limit=100" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "pagination": {
    "order_by": "created_at",
    "dir": "desc",
    "limit": 100
  },
  "count": 1,
  "models": [
    {
      "id": "trs_2jYb7sL8mN4pQ9rT",
      "team_id": "tm_3b5335b627084a838b",
      "name": "normalize-billing-event",
      "code": "request.body.normalized = true; return request;",
      "env": {
        "provider": "stripe"
      },
      "code_hash": "9a1b2c3d4e5f60718293a4b5c6d7e8f901234567",
      "created_at": "2026-01-14T13:35:56.019Z",
      "updated_at": "2026-01-14T13:36:41.602Z",
      "deleted_at": null,
      "executions_24h_count": 0,
      "executions_24h_successful_count": 0,
      "executions_24h_failed_count": 0,
      "executions_24h_successful_bins": [0, 0, 0, 0, 0, 0],
      "executions_24h_failed_bins": [0, 0, 0, 0, 0, 0],
      "connections_count": 0
    }
  ]
}

Create a transformation input parameters

Create a transformation accepts the route, header, query, and body inputs listed below.

Create a transformation request body

namestringRequired

required Used by the Create a transformation operation.

codestringRequired

required Used by the Create a transformation operation.

envobjectOptional

optional object Used by the Create a transformation operation.

Request

Shell

curl -X POST \
  "https://api.fasthook.io/v1/transformations" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "name": "Normalize billing event",
  "code": "return request;",
  "env": {}
}'

Response

JSON

{
  "id": "trs_2jYb7sL8mN4pQ9rT",
  "team_id": "tm_3b5335b627084a838b",
  "name": "Normalize billing event",
  "code": "return request;",
  "env": {},
  "code_hash": "9a1b2c3d4e5f60718293a4b5c6d7e8f901234567",
  "created_at": "2026-01-14T13:35:56.019Z",
  "updated_at": "2026-01-14T13:35:56.019Z",
      "deleted_at": null,
      "executions_24h_count": 0,
      "executions_24h_successful_count": 0,
      "executions_24h_failed_count": 0,
      "executions_24h_successful_bins": [0, 0, 0, 0, 0, 0],
      "executions_24h_failed_bins": [0, 0, 0, 0, 0, 0],
      "connections_count": 0
}

Upsert a transformation input parameters

Upsert a transformation accepts the route, header, query, and body inputs listed below.

Upsert a transformation request body

namestringRequired

required string Used by the Upsert a transformation operation.

codestringRequired

required string Used by the Upsert a transformation operation.

envobjectOptional

optional object Used by the Upsert a transformation operation.

Request

Shell

curl -X PUT \
  "https://api.fasthook.io/v1/transformations" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "name": "Normalize billing event",
  "code": "request.body.normalized = true; return request;",
  "env": {
    "provider": "stripe"
  }
}'

Response

JSON

{
  "id": "trs_2jYb7sL8mN4pQ9rT",
  "team_id": "tm_3b5335b627084a838b",
  "name": "Normalize billing event",
  "code": "return request;",
  "env": {},
  "code_hash": "9a1b2c3d4e5f60718293a4b5c6d7e8f901234567",
  "created_at": "2026-01-14T13:35:56.019Z",
  "updated_at": "2026-01-14T13:36:41.602Z",
      "deleted_at": null,
      "executions_24h_count": 0,
      "executions_24h_successful_count": 0,
      "executions_24h_failed_count": 0,
      "executions_24h_successful_bins": [0, 0, 0, 0, 0, 0],
      "executions_24h_failed_bins": [0, 0, 0, 0, 0, 0],
      "connections_count": 1
}

Run a transformation input parameters

Run a transformation accepts the route, header, query, and body inputs listed below.

Run a transformation request body

transformation_idstringOptional

optional saved transformation ID Used by the Run a transformation operation.

codestringOptional

optional JavaScript code when transformation_id is omitted Used by the Run a transformation operation.

envobjectOptional

optional object of string variables Used by the Run a transformation operation.

request.headersobjectOptional

optional object Used by the Run a transformation operation.

request.bodystringOptional

optional JSON value Used by the Run a transformation operation.

request.queryobjectOptional

optional object or query string Used by the Run a transformation operation.

request.pathstringOptional

optional path string Used by the Run a transformation operation.

request.methodstringOptional

optional HTTP method Used by the Run a transformation operation.

Request

Shell

curl -X PUT \
  "https://api.fasthook.io/v1/transformations/run" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "transformation_id": "trs_2jYb7sL8mN4pQ9rT",
  "code": "return request;",
  "env": {
    "provider": "stripe"
  },
  "request": {
    "headers": {
      "content-type": "application/json"
    },
    "body": { "type": "invoice.created" },
    "query": {
      "source": "stripe"
    },
    "path": "/stripe/invoices",
    "method": "POST"
  }
}'

Response

JSON

{
  "log_level": "info",
  "console": [],
  "request": {
    "headers": {},
    "body": { "type": "invoice.created" },
    "query": {},
    "path": "/",
    "method": "POST"
  },
  "transformation_run_time": {
    "started_at": "2026-02-27T00:00:00.000Z",
    "finished_at": "2026-02-27T00:00:00.004Z",
    "duration_ms": 4
  }
}

Retrieve a transformation input parameters

Retrieve a transformation accepts the route, header, query, and body inputs listed below.

Retrieve a transformation path parameters

idstringRequired

Transformation ID. Used by the Retrieve a transformation operation.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/transformations/trs_2jYb7sL8mN4pQ9rT" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "id": "trs_2jYb7sL8mN4pQ9rT",
  "team_id": "tm_3b5335b627084a838b",
  "name": "Normalize billing event",
  "code": "return request;",
  "env": {},
  "code_hash": "9a1b2c3d4e5f60718293a4b5c6d7e8f901234567",
  "created_at": "2026-01-14T13:35:56.019Z",
  "updated_at": "2026-01-14T13:36:41.602Z",
  "deleted_at": null,
  "executions_24h_count": 8,
  "executions_24h_successful_count": 7,
  "executions_24h_failed_count": 1,
  "executions_24h_successful_bins": [0, 0, 0, 0, 2, 5],
  "executions_24h_failed_bins": [0, 0, 0, 0, 1, 0],
  "connections_count": 2
}

Update a transformation input parameters

Update a transformation accepts the route, header, query, and body inputs listed below.

Update a transformation path parameters

idstringRequired

Transformation ID. Used by the Update a transformation operation.

Update a transformation request body

namestringOptional

optional string Used by the Update a transformation operation.

codestringOptional

optional string Used by the Update a transformation operation.

envobjectOptional

optional object Used by the Update a transformation operation.

Request

Shell

curl -X PUT \
  "https://api.fasthook.io/v1/transformations/trs_2jYb7sL8mN4pQ9rT" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "name": "Normalize billing event",
  "code": "request.body.normalized = true; return request;",
  "env": {
    "provider": "stripe"
  }
}'

Response

JSON

{
  "id": "trs_2jYb7sL8mN4pQ9rT",
  "team_id": "tm_3b5335b627084a838b",
  "name": "Normalize billing event",
  "code": "request.body.normalized = true; return request;",
  "env": {
    "provider": "stripe"
  },
  "code_hash": "4e5f60718293a4b5c6d7e8f90123456789abcdef",
  "created_at": "2026-01-14T13:35:56.019Z",
  "updated_at": "2026-05-10T18:08:12.110Z",
  "deleted_at": null,
  "executions_24h_count": 8,
  "executions_24h_successful_count": 7,
  "executions_24h_failed_count": 1,
  "executions_24h_successful_bins": [0, 0, 0, 0, 2, 5],
  "executions_24h_failed_bins": [0, 0, 0, 0, 1, 0],
  "connections_count": 2
}

Delete a transformation input parameters

Delete a transformation accepts the route, header, query, and body inputs listed below.

Delete a transformation path parameters

idstringRequired

Transformation ID. Used by the Delete a transformation operation.

Request

Shell

curl -X DELETE \
  "https://api.fasthook.io/v1/transformations/trs_2jYb7sL8mN4pQ9rT" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "id": "trs_2jYb7sL8mN4pQ9rT"
}

List transformation executions input parameters

List transformation executions accepts the route, header, query, and body inputs listed below.

List transformation executions path parameters

idstringRequired

Transformation ID. Used by the List transformation executions operation.

List transformation executions notes

Execution models include team_id for the owning team.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/transformations/trs_2jYb7sL8mN4pQ9rT/executions" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "pagination": {
    "order_by": "created_at",
    "dir": "desc",
    "limit": 100
  },
  "count": 1,
  "models": [
    {
      "id": "txe_01jv8c1h3z7r6b5n4m2k9q8p0x",
      "team_id": "tm_3b5335b627084a838b",
      "event_id": "evt_01jv8c4n9p3x7r2t6q5m1k0s8b",
      "created_at": "2026-01-14T13:36:41.620Z",
      "updated_at": "2026-01-14T13:36:41.624Z",
      "webhook_id": "web_nbbweTiOtzsm",
      "transformed_event_data_id": "evd_01jv8c1h3z7r6b5n4m2k9q8p0y",
      "original_event_data_id": "evd_01jv8c1h3z7r6b5n4m2k9q8p0x",
      "transformation_id": "trs_2jYb7sL8mN4pQ9rT",
      "log_level": "info",
      "logs": [
        {
          "level": "info",
          "message": "normalized billing event",
          "timestamp": "2026-01-14T13:36:41.623Z"
        }
      ]
    }
  ]
}

Retrieve a transformation execution input parameters

Retrieve a transformation execution accepts the route, header, query, and body inputs listed below.

Retrieve a transformation execution path parameters

idstringRequired

Transformation ID. Used by the Retrieve a transformation execution operation.

executionIdstringRequired

Transformation execution ID. Used by the Retrieve a transformation execution operation.

Retrieve a transformation execution notes

The response includes team_id for the owning team.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/transformations/trs_2jYb7sL8mN4pQ9rT/executions/txe_01jv8c1h3z7r6b5n4m2k9q8p0x" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "id": "txe_01jv8c1h3z7r6b5n4m2k9q8p0x",
  "event_id": "evt_01jv8c4n9p3x7r2t6q5m1k0s8b",
  "original_event_data_id": "evd_01jv8c1h3z7r6b5n4m2k9q8p0x",
  "transformed_event_data_id": "evd_01jv8c1h3z7r6b5n4m2k9q8p0y",
  "team_id": "tm_3b5335b627084a838b",
  "webhook_id": "web_nbbweTiOtzsm",
  "transformation_id": "trs_2jYb7sL8mN4pQ9rT",
  "log_level": "info",
  "logs": [
    {
      "level": "info",
      "message": "normalized billing event",
      "timestamp": "2026-01-14T13:36:41.623Z"
    }
  ],
  "created_at": "2026-01-14T13:36:41.620Z",
  "updated_at": "2026-01-14T13:36:41.624Z",
  "original_event_data": {
    "headers": {
      "content-type": "application/json"
    },
    "body": {
      "type": "invoice.created",
      "id": "evt_stripe_01jv8c1h"
    },
    "query": {},
    "path": "/",
    "method": "POST"
  },
  "transformed_event_data": {
    "headers": {
      "content-type": "application/json"
    },
    "body": {
      "type": "invoice.created",
      "id": "evt_stripe_01jv8c1h",
      "normalized": true
    },
    "query": {},
    "path": "/",
    "method": "POST"
  }
}

Request Fixtures

Request fixtures save real inbound webhook payloads as named test cases that can be replayed through a selected connection.

Request Fixtures response fields

11 fields

idfix_*

Unique fixture ID. Request fixture IDs use the fix_ prefix.

team_id

Team that owns the saved request fixture.

name

Human-readable test-case name, such as Successful payment or Invalid signature.

description

Optional expected result, edge case, or operator note for the fixture.

source_id

Source from which the original webhook request was captured.

source_name

Source name captured for display alongside the fixture.

original_request_id

Inbound request used to create the immutable fixture payload snapshot.

replay_count

Number of fixture replays queued so far.

last_replayed_at

ISO timestamp of the most recent replay, or null before the first replay.

created_at

ISO timestamp when the fixture was saved.

updated_at

ISO timestamp when the fixture metadata or replay counters last changed.

List request fixtures input parameters

List request fixtures does not require path, query, or body parameters.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/request-fixtures" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "count": 2,
  "models": [
    {
      "id": "fix_01jv8cf4m2q7r9t5x3n6k1s8p0",
      "team_id": "tm_3b5335b627084a838b",
      "name": "Successful payment",
      "description": "Expected 200 response from the billing destination.",
      "source_id": "src_q6z62b6py5o79b",
      "source_name": "stripe-webhooks",
      "original_request_id": "req_01jv8c3m7b2p4q9x6r5t1n0k8s",
      "replay_count": 3,
      "last_replayed_at": "2026-07-18T08:24:13.201Z",
      "created_at": "2026-07-17T16:10:00.000Z",
      "updated_at": "2026-07-18T08:24:13.201Z"
    }
  ]
}

Save a request fixture input parameters

Save a request fixture accepts the route, header, query, and body inputs listed below.

Save a request fixture request body

request_idstringRequired

required request ID Used by the Save a request fixture operation.

namestringRequired

required string, max 120 characters Used by the Save a request fixture operation.

descriptionstringOptional

optional string, max 500 characters Used by the Save a request fixture operation.

Save a request fixture notes

The request payload, headers, path, query, and HTTP method are copied into the fixture snapshot.

Request

Shell

curl -X POST \
  "https://api.fasthook.io/v1/request-fixtures" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "request_id": "req_01jv8c3m7b2p4q9x6r5t1n0k8s",
  "name": "Successful payment",
  "description": "Expected 200 response from the billing destination."
}'

Response

JSON

{
  "id": "fix_01jv8cf4m2q7r9t5x3n6k1s8p0",
  "team_id": "tm_3b5335b627084a838b",
  "name": "Successful payment",
  "description": "Expected 200 response from the billing destination.",
  "source_id": "src_q6z62b6py5o79b",
  "source_name": "stripe-webhooks",
  "original_request_id": "req_01jv8c3m7b2p4q9x6r5t1n0k8s",
  "replay_count": 0,
  "last_replayed_at": null,
  "created_at": "2026-07-18T08:20:00.000Z",
  "updated_at": "2026-07-18T08:20:00.000Z"
}

Retrieve a request fixture input parameters

Retrieve a request fixture accepts the route, header, query, and body inputs listed below.

Retrieve a request fixture path parameters

idstringRequired

Saved request fixture ID. Used by the Retrieve a request fixture operation.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/request-fixtures/fix_01jv8cf4m2q7r9t5x3n6k1s8p0" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "id": "fix_01jv8cf4m2q7r9t5x3n6k1s8p0",
  "team_id": "tm_3b5335b627084a838b",
  "name": "Successful payment",
  "description": "Expected 200 response from the billing destination.",
  "source_id": "src_q6z62b6py5o79b",
  "source_name": "stripe-webhooks",
  "original_request_id": "req_01jv8c3m7b2p4q9x6r5t1n0k8s",
  "replay_count": 3,
  "last_replayed_at": "2026-07-18T08:24:13.201Z",
  "created_at": "2026-07-17T16:10:00.000Z",
  "updated_at": "2026-07-18T08:24:13.201Z"
}

Update a request fixture input parameters

Update a request fixture accepts the route, header, query, and body inputs listed below.

Update a request fixture path parameters

idstringRequired

Saved request fixture ID. Used by the Update a request fixture operation.

Update a request fixture request body

namestringOptional

optional string, max 120 characters Used by the Update a request fixture operation.

descriptionstringOptional

optional string or null, max 500 characters Used by the Update a request fixture operation.

Request

Shell

curl -X PATCH \
  "https://api.fasthook.io/v1/request-fixtures/fix_01jv8cf4m2q7r9t5x3n6k1s8p0" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "name": "Successful Stripe payment",
  "description": "Must create one paid order without duplicate side effects."
}'

Response

JSON

{
  "id": "fix_01jv8cf4m2q7r9t5x3n6k1s8p0",
  "team_id": "tm_3b5335b627084a838b",
  "name": "Successful Stripe payment",
  "description": "Must create one paid order without duplicate side effects.",
  "source_id": "src_q6z62b6py5o79b",
  "source_name": "stripe-webhooks",
  "original_request_id": "req_01jv8c3m7b2p4q9x6r5t1n0k8s",
  "replay_count": 3,
  "last_replayed_at": "2026-07-18T08:24:13.201Z",
  "created_at": "2026-07-17T16:10:00.000Z",
  "updated_at": "2026-07-18T08:30:00.000Z"
}

Delete a request fixture input parameters

Delete a request fixture accepts the route, header, query, and body inputs listed below.

Delete a request fixture path parameters

idstringRequired

Saved request fixture ID. Used by the Delete a request fixture operation.

Request

Shell

curl -X DELETE \
  "https://api.fasthook.io/v1/request-fixtures/fix_01jv8cf4m2q7r9t5x3n6k1s8p0" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "deleted": true,
  "id": "fix_01jv8cf4m2q7r9t5x3n6k1s8p0"
}

List fixture replay targets input parameters

List fixture replay targets accepts the route, header, query, and body inputs listed below.

List fixture replay targets path parameters

idstringRequired

Saved request fixture ID. Used by the List fixture replay targets operation.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/request-fixtures/fix_01jv8cf4m2q7r9t5x3n6k1s8p0/targets" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "models": [
    {
      "connection_id": "web_nbbweTiOtzsm",
      "connection_name": "stripe-to-billing",
      "source_id": "src_q6z62b6py5o79b",
      "source_name": "stripe-webhooks",
      "destination_id": "des_TU9ioCk5EHUU",
      "destination_name": "billing-api",
      "destination_type": "HTTP"
    }
  ]
}

Replay a request fixture input parameters

Replay a request fixture accepts the route, header, query, and body inputs listed below.

Replay a request fixture path parameters

idstringRequired

Saved request fixture ID. Used by the Replay a request fixture operation.

Replay a request fixture request body

connection_idstringRequired

required connection ID returned by the targets endpoint Used by the Replay a request fixture operation.

Replay a request fixture notes

Returns 202 Accepted after the replay message is published.

Request

Shell

curl -X POST \
  "https://api.fasthook.io/v1/request-fixtures/fix_01jv8cf4m2q7r9t5x3n6k1s8p0/replay" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "connection_id": "web_nbbweTiOtzsm"
}'

Response

JSON

{
  "queued": true,
  "fixture_id": "fix_01jv8cf4m2q7r9t5x3n6k1s8p0",
  "connection_id": "web_nbbweTiOtzsm",
  "destination_id": "des_TU9ioCk5EHUU",
  "message_id": "fxr_01jv8cj9q2r5t7x3m6k1s4n0p8",
  "replayed_at": "2026-07-18T08:34:26.402Z"
}

Connections

Connections route events from one source to one destination and apply rules.

Connections response fields

11 fields

idweb_*

Unique connection ID. Connection IDs use the web_ prefix.

team_id

Team that owns the connection.

name

Human-readable connection name, unique within the team.

description

Optional description for operators and API clients.

source

Source object that receives inbound webhook requests.

destination

Destination object that receives routed event deliveries.

rules

Ordered connection rules applied during routing and delivery.

disabled_at

ISO timestamp when the connection was disabled, or null when active.

paused_at

ISO timestamp when event delivery was paused, or null when unpaused.

created_at

ISO timestamp when the connection was created.

updated_at

ISO timestamp when the connection was last changed.

List connections input parameters

List connections accepts the route, header, query, and body inputs listed below.

List connections query parameters

order_byenumOptional

name | created_at | updated_at Used by the List connections operation.

direnumOptional

asc | desc Used by the List connections operation.

limitintegerOptional

max 255 Used by the List connections operation.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/connections?order_by=created_at&dir=desc&limit=100" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "pagination": {
    "order_by": "created_at",
    "dir": "desc",
    "limit": 100
  },
  "count": 1,
  "models": [
    {
      "id": "web_nbbweTiOtzsm",
      "team_id": "tm_3b5335b627084a838b",
      "updated_at": "2026-01-14T13:36:41.582Z",
      "created_at": "2026-01-14T13:36:41.595Z",
      "paused_at": null,
      "source_id": "src_q6z62b6py5o79b",
      "destination_id": "des_TU9ioCk5EHUU",
      "name": "stripe-to-production-api",
      "description": "Route Stripe billing events to the production API",
      "rules": [
        {
          "type": "retry",
          "strategy": "exponential",
          "interval": 1000,
          "count": 5,
          "response_status_codes": ["500-599", "!501"]
        }
      ],
      "source": {
        "id": "src_q6z62b6py5o79b",
        "team_id": "tm_3b5335b627084a838b",
        "updated_at": "2026-01-14T13:36:41.583Z",
        "created_at": "2026-01-14T13:35:55.226Z",
        "name": "stripe-production",
        "description": "Stripe billing webhook source",
        "type": "WEBHOOK",
        "url": "https://hook-xxxxxx.fasthook.io/",
        "config": {
          "auth_type": "BASIC_AUTH",
          "auth": {
            "username": "stripe-webhook",
            "password": "secret-password"
          },
        "custom_response": {
          "content_type": "json",
          "body": "{\"received\":true}"
        },
        "mode": "webhook",
        "proxy": null,
        "allowed_http_methods": ["POST", "PUT", "PATCH", "DELETE"]
      },
        "disabled_at": null
      },
      "destination": {
        "id": "des_TU9ioCk5EHUU",
        "team_id": "tm_3b5335b627084a838b",
        "updated_at": "2026-01-14T13:36:41.584Z",
        "created_at": "2026-01-14T13:35:55.263Z",
        "name": "production-api",
        "description": "Primary billing event consumer",
        "type": "HTTP",
        "config": {
          "url": "https://api.example.com/webhooks",
          "path": null,
          "rate_limit": null,
          "rate_limit_period": "second",
          "http_method": "POST",
          "path_forwarding_disabled": false,
          "auth_type": "FASTHOOK_SIGNATURE",
          "auth": {}
        },
        "disabled_at": null
      },
      "disabled_at": null
    }
  ]
}

Retrieve a connection input parameters

Retrieve a connection accepts the route, header, query, and body inputs listed below.

Retrieve a connection path parameters

idstringRequired

Connection ID. Used by the Retrieve a connection operation.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/connections/web_nbbweTiOtzsm" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "id": "web_nbbweTiOtzsm",
  "team_id": "tm_3b5335b627084a838b",
  "updated_at": "2026-01-14T13:36:41.582Z",
  "created_at": "2026-01-14T13:36:41.595Z",
  "paused_at": null,
  "source_id": "src_q6z62b6py5o79b",
  "destination_id": "des_TU9ioCk5EHUU",
  "name": "invoices",
  "description": "Route invoice events to billing API",
  "source": {
    "id": "src_q6z62b6py5o79b",
    "team_id": "tm_3b5335b627084a838b",
    "name": "Stripe",
    "description": "Stripe billing webhook source",
    "type": "WEBHOOK",
    "url": "https://hook-xxxxxx.fasthook.io/",
    "config": {
      "auth_type": "BASIC_AUTH",
      "auth": {
        "username": "stripe-webhook",
        "password": "secret-password"
      },
      "custom_response": {
        "content_type": "json",
        "body": "{\"received\":true}"
      },
      "allowed_http_methods": ["POST", "PUT", "PATCH", "DELETE"]
    },
    "disabled_at": null,
    "created_at": "2026-01-14T13:35:55.226Z",
    "updated_at": "2026-01-14T13:36:41.583Z"
  },
  "destination": {
    "id": "des_TU9ioCk5EHUU",
    "team_id": "tm_3b5335b627084a838b",
    "name": "Production API",
    "type": "HTTP",
    "description": "Primary billing event consumer",
    "config": {
      "url": "https://api.example.com/webhooks",
      "path": null,
      "rate_limit": null,
      "rate_limit_period": "second",
      "http_method": "POST",
      "path_forwarding_disabled": false,
      "auth_type": "FASTHOOK_SIGNATURE",
      "auth": {}
    },
    "disabled_at": null,
    "created_at": "2026-01-14T13:35:55.263Z",
    "updated_at": "2026-01-14T13:36:41.584Z"
  },
  "rules": [
    {
      "type": "retry",
      "strategy": "exponential",
      "interval": 1000,
      "count": 5,
      "response_status_codes": ["500-599", "!501"]
    }
  ],
  "disabled_at": null
}

Create a connection input parameters

Create a connection accepts the route, header, query, and body inputs listed below.

Create a connection request body

namestringRequired

required string Used by the Create a connection operation.

descriptionstringOptional

optional string or null Used by the Create a connection operation.

source_id or source.idstringRequired

required source ID Used by the Create a connection operation.

destination_id or destination.idstringRequired

required destination ID Used by the Create a connection operation.

disabled_atdatetimeOptional

optional ISO datetime when delivery should be disabled, or null Used by the Create a connection operation.

paused_atdatetimeOptional

optional ISO datetime when delivery should be paused, or null Used by the Create a connection operation.

rulesarrayOptional

optional array of retry, delay, filter, transform, and deduplicate rules Used by the Create a connection operation.

Request

Shell

curl -X POST \
  "https://api.fasthook.io/v1/connections" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "name": "invoices",
  "description": "Route invoice events to billing API",
  "source_id": "src_q6z62b6py5o79b",
  "destination_id": "des_TU9ioCk5EHUU",
  "disabled_at": null,
  "paused_at": null,
  "rules": [
    {
      "type": "deduplicate",
      "window": 60000,
      "include_fields": ["body.id", "headers.stripe-signature"],
      "exclude_fields": ["headers.request-id"]
    },
    {
      "type": "transform",
      "transformation": {
        "name": "Normalize billing event",
        "code": "request.body.normalized = true; return request;",
        "env": {
          "provider": "stripe"
        }
      }
    },
    {
      "type": "filter",
      "headers": {
        "stripe-signature": { "$exists": true }
      },
      "body": {
        "type": "invoice.paid"
      },
      "query": {
        "livemode": "true"
      },
      "path": {
        "$starts_with": "/stripe"
      }
    },
    {
      "type": "delay",
      "delay": 5000
    },
    {
      "type": "retry",
      "strategy": "exponential",
      "interval": 1000,
      "count": 5,
      "response_status_codes": ["500-599", "!501"]
    }
  ]
}'

Response

JSON

{
  "id": "web_nbbweTiOtzsm",
  "team_id": "tm_3b5335b627084a838b",
  "source_id": "src_q6z62b6py5o79b",
  "destination_id": "des_TU9ioCk5EHUU",
  "name": "invoices",
  "description": null,
  "source": {
    "id": "src_q6z62b6py5o79b",
    "team_id": "tm_3b5335b627084a838b",
    "name": "Stripe",
    "description": "Stripe billing webhook source",
    "type": "WEBHOOK",
    "url": "https://hook-xxxxxx.fasthook.io/",
    "config": {
      "auth_type": "BASIC_AUTH",
      "auth": {
        "username": "stripe-webhook",
        "password": "secret-password"
      },
      "custom_response": {
        "content_type": "json",
        "body": "{\"received\":true}"
      },
      "allowed_http_methods": ["POST", "PUT", "PATCH", "DELETE"]
    },
    "disabled_at": null,
    "created_at": "2026-01-14T13:35:55.226Z",
    "updated_at": "2026-01-14T13:36:41.583Z"
  },
  "destination": {
    "id": "des_TU9ioCk5EHUU",
    "team_id": "tm_3b5335b627084a838b",
    "name": "Production API",
    "description": "Primary billing event consumer",
    "type": "HTTP",
    "config": {
      "url": "https://api.example.com/webhooks",
      "path": null,
      "rate_limit": null,
      "rate_limit_period": "second",
      "http_method": "POST",
      "path_forwarding_disabled": false,
      "auth_type": "FASTHOOK_SIGNATURE",
      "auth": {}
    },
    "disabled_at": null,
    "created_at": "2026-01-14T13:35:55.263Z",
    "updated_at": "2026-01-14T13:36:41.584Z"
  },
  "rules": [
    {
      "type": "retry",
      "strategy": "exponential",
      "interval": 1000,
      "count": 5,
      "response_status_codes": ["500-599", "!501"]
    }
  ],
  "disabled_at": null,
  "paused_at": null,
  "created_at": "2026-01-14T13:36:41.595Z",
  "updated_at": "2026-01-14T13:36:41.595Z"
}

Upsert a connection input parameters

Upsert a connection accepts the route, header, query, and body inputs listed below.

Upsert a connection request body

idstringOptional

optional connection ID to upsert directly Used by the Upsert a connection operation.

namestringRequired

required string when id is omitted Used by the Upsert a connection operation.

descriptionstringOptional

optional string or null Used by the Upsert a connection operation.

source_id or source.idstringRequired

required source ID Used by the Upsert a connection operation.

destination_id or destination.idstringRequired

required destination ID Used by the Upsert a connection operation.

disabled_atdatetimeOptional

optional ISO datetime to disable delivery during the upsert, or null Used by the Upsert a connection operation.

paused_atdatetimeOptional

optional ISO datetime to pause delivery during the upsert, or null Used by the Upsert a connection operation.

rulesarrayOptional

optional array of retry, delay, filter, transform, and deduplicate rules Used by the Upsert a connection operation.

Request

Shell

curl -X PUT \
  "https://api.fasthook.io/v1/connections" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "id": "web_nbbweTiOtzsm",
  "name": "invoices",
  "description": "Route invoice events to billing API",
  "source_id": "src_q6z62b6py5o79b",
  "destination_id": "des_TU9ioCk5EHUU",
  "disabled_at": null,
  "paused_at": null,
  "rules": [
    {
      "type": "deduplicate",
      "window": 60000,
      "include_fields": ["body.id"],
      "exclude_fields": ["headers.request-id"]
    },
    {
      "type": "filter",
      "body": {
        "type": "invoice.paid"
      },
      "path": {
        "$starts_with": "/stripe"
      }
    },
    {
      "type": "retry",
      "strategy": "exponential",
      "interval": 1000,
      "count": 5,
      "response_status_codes": ["500-599", "!501"]
    }
  ]
}'

Response

JSON

{
  "id": "web_nbbweTiOtzsm",
  "team_id": "tm_3b5335b627084a838b",
  "source_id": "src_q6z62b6py5o79b",
  "destination_id": "des_TU9ioCk5EHUU",
  "name": "invoices",
  "description": null,
  "source": {
    "id": "src_q6z62b6py5o79b",
    "team_id": "tm_3b5335b627084a838b",
    "name": "Stripe",
    "description": "Stripe billing webhook source",
    "type": "WEBHOOK",
    "url": "https://hook-xxxxxx.fasthook.io/",
    "config": {
      "auth_type": "BASIC_AUTH",
      "auth": {
        "username": "stripe-webhook",
        "password": "secret-password"
      },
      "custom_response": {
        "content_type": "json",
        "body": "{\"received\":true}"
      },
      "allowed_http_methods": ["POST", "PUT", "PATCH", "DELETE"]
    },
    "disabled_at": null,
    "created_at": "2026-01-14T13:35:55.226Z",
    "updated_at": "2026-01-14T13:36:41.583Z"
  },
  "destination": {
    "id": "des_TU9ioCk5EHUU",
    "team_id": "tm_3b5335b627084a838b",
    "name": "Production API",
    "description": "Primary billing event consumer",
    "type": "HTTP",
    "config": {
      "url": "https://api.example.com/webhooks",
      "path": null,
      "rate_limit": null,
      "rate_limit_period": "second",
      "http_method": "POST",
      "path_forwarding_disabled": false,
      "auth_type": "FASTHOOK_SIGNATURE",
      "auth": {}
    },
    "disabled_at": null,
    "created_at": "2026-01-14T13:35:55.263Z",
    "updated_at": "2026-01-14T13:36:41.584Z"
  },
  "rules": [
    {
      "type": "retry",
      "strategy": "exponential",
      "interval": 1000,
      "count": 5,
      "response_status_codes": ["500-599", "!501"]
    }
  ],
  "disabled_at": null,
  "paused_at": null,
  "created_at": "2026-01-14T13:36:41.595Z",
  "updated_at": "2026-01-14T13:36:41.595Z"
}

Update a connection input parameters

Update a connection accepts the route, header, query, and body inputs listed below.

Update a connection path parameters

idstringRequired

Connection ID. Used by the Update a connection operation.

Update a connection request body

namestringOptional

optional string Used by the Update a connection operation.

descriptionstringOptional

optional string or null Used by the Update a connection operation.

source_id or source.idstringOptional

optional source ID Used by the Update a connection operation.

destination_id or destination.idstringOptional

optional destination ID Used by the Update a connection operation.

disabled_atdatetimeOptional

optional ISO datetime to change the disabled state, or null Used by the Update a connection operation.

paused_atdatetimeOptional

optional ISO datetime to change the paused state, or null Used by the Update a connection operation.

rulesarrayOptional

optional array of retry, delay, filter, transform, and deduplicate rules Used by the Update a connection operation.

Request

Shell

curl -X PUT \
  "https://api.fasthook.io/v1/connections/web_nbbweTiOtzsm" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "name": "invoices",
  "description": "Route invoice events to billing API",
  "source_id": "src_q6z62b6py5o79b",
  "destination_id": "des_TU9ioCk5EHUU",
  "disabled_at": null,
  "paused_at": null,
  "rules": [
    {
      "type": "filter",
      "body": {
        "type": "invoice.paid"
      },
      "path": {
        "$starts_with": "/stripe"
      }
    },
    {
      "type": "retry",
      "strategy": "exponential",
      "interval": 1000,
      "count": 5,
      "response_status_codes": ["500-599", "!501"]
    }
  ]
}'

Response

JSON

{
  "id": "web_nbbweTiOtzsm",
  "team_id": "tm_3b5335b627084a838b",
  "source_id": "src_q6z62b6py5o79b",
  "destination_id": "des_TU9ioCk5EHUU",
  "name": "invoices",
  "description": "Route invoice events to billing API",
  "rules": [
    {
      "type": "filter",
      "body": {
        "type": "invoice.paid"
      },
      "path": {
        "$starts_with": "/stripe"
      }
    }
  ],
  "source": {
    "id": "src_q6z62b6py5o79b",
    "team_id": "tm_3b5335b627084a838b",
    "name": "Stripe",
    "description": "Stripe billing webhook source",
    "type": "WEBHOOK",
    "url": "https://hook-xxxxxx.fasthook.io/",
    "config": {
      "auth_type": "BASIC_AUTH",
      "auth": {
        "username": "stripe-webhook",
        "password": "secret-password"
      },
      "custom_response": {
        "content_type": "json",
        "body": "{\"received\":true}"
      },
      "allowed_http_methods": ["POST", "PUT", "PATCH", "DELETE"]
    },
    "disabled_at": null,
    "created_at": "2026-01-14T13:35:55.226Z",
    "updated_at": "2026-01-14T13:36:41.583Z"
  },
  "destination": {
    "id": "des_TU9ioCk5EHUU",
    "team_id": "tm_3b5335b627084a838b",
    "name": "Production API",
    "description": "Primary billing event consumer",
    "type": "HTTP",
    "config": {
      "url": "https://api.example.com/webhooks",
      "path": null,
      "rate_limit": null,
      "rate_limit_period": "second",
      "http_method": "POST",
      "path_forwarding_disabled": false,
      "auth_type": "FASTHOOK_SIGNATURE",
      "auth": {}
    },
    "disabled_at": null,
    "created_at": "2026-01-14T13:35:55.263Z",
    "updated_at": "2026-01-14T13:36:41.584Z"
  },
  "disabled_at": null,
  "paused_at": null,
  "created_at": "2026-01-14T13:36:41.595Z",
  "updated_at": "2026-05-10T18:10:02.204Z"
}

Retrieve latest input input parameters

Retrieve latest input accepts the route, header, query, and body inputs listed below.

Retrieve latest input path parameters

idstringRequired

Connection ID. Used by the Retrieve latest input operation.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/connections/web_nbbweTiOtzsm/latest-input" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "connection_id": "web_nbbweTiOtzsm",
  "latest_input": {
    "source_id": "src_q6z62b6py5o79b",
    "request_id": "req_01jv8c3m7b2p4q9x6r5t1n0k8s",
    "original_event_data_id": "evd_01jv8c3m7b2p4q9x6r5t1n0k8s",
    "ingested_at": "2026-04-17T00:00:00.000Z",
    "payload_r2_key": "raw-source/tm_3b5335b627084a838b/src_q6z62b6py5o79b/req_01jv8c3m7b2p4q9x6r5t1n0k8s.json",
    "payload_r2_bucket_name": "EVENT_DATA_BUCKET",
    "input": {
      "headers": {
        "content-type": "application/json",
        "stripe-signature": "t=1765303200,v1=8aab0c2b25d4f5d66118863b1b8a4f31"
      },
      "body": {
        "id": "evt_stripe_01jv8c3m",
        "type": "invoice.paid",
        "data": {
          "object": {
            "id": "in_01jv8c3m",
            "amount_paid": 4900,
            "currency": "usd"
          }
        }
      },
      "query": {},
      "path": "/",
      "method": "POST"
    }
  }
}

Pause a connection input parameters

Pause a connection accepts the route, header, query, and body inputs listed below.

Pause a connection path parameters

idstringRequired

Connection ID. Used by the Pause a connection operation.

Request

Shell

curl -X PUT \
  "https://api.fasthook.io/v1/connections/web_nbbweTiOtzsm/pause" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "id": "web_nbbweTiOtzsm",
  "team_id": "tm_3b5335b627084a838b",
  "source_id": "src_q6z62b6py5o79b",
  "destination_id": "des_TU9ioCk5EHUU",
  "name": "invoices",
  "description": "Route invoice events to billing API",
  "disabled_at": null,
  "updated_at": "2026-05-10T18:00:00.000Z",
  "created_at": "2026-01-14T13:36:41.595Z",
  "paused_at": "2026-05-10T18:00:00.000Z",
  "rules": [
    {
      "type": "retry",
      "strategy": "exponential",
      "interval": 1000,
      "count": 5,
      "response_status_codes": [
        "500-599",
        "!501"
      ]
    }
  ],
  "destination": {
    "id": "des_TU9ioCk5EHUU",
    "team_id": "tm_3b5335b627084a838b",
    "name": "Production API",
    "description": "Primary billing event consumer",
    "type": "HTTP",
    "config": {
      "url": "https://api.example.com/webhooks",
      "path": null,
      "rate_limit": null,
      "rate_limit_period": "second",
      "http_method": "POST",
      "path_forwarding_disabled": false,
      "auth_type": "FASTHOOK_SIGNATURE",
      "auth": {}
    },
    "disabled_at": null,
    "created_at": "2026-01-14T13:35:55.263Z",
    "updated_at": "2026-01-14T13:36:41.584Z"
  },
  "source": {
    "id": "src_q6z62b6py5o79b",
    "team_id": "tm_3b5335b627084a838b",
    "name": "Stripe",
    "description": "Stripe billing webhook source",
    "type": "WEBHOOK",
    "url": "https://hook-xxxxxx.fasthook.io/",
    "config": {
      "auth_type": "BASIC_AUTH",
      "auth": {
        "username": "stripe-webhook",
        "password": "secret-password"
      },
      "custom_response": {
        "content_type": "json",
        "body": "{\"received\":true}"
      },
      "allowed_http_methods": ["POST", "PUT", "PATCH", "DELETE"]
    },
    "disabled_at": null,
    "created_at": "2026-01-14T13:35:55.226Z",
    "updated_at": "2026-01-14T13:36:41.583Z"
  }
}

Unpause a connection input parameters

Unpause a connection accepts the route, header, query, and body inputs listed below.

Unpause a connection path parameters

idstringRequired

Connection ID. Used by the Unpause a connection operation.

Request

Shell

curl -X PUT \
  "https://api.fasthook.io/v1/connections/web_nbbweTiOtzsm/unpause" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "id": "web_nbbweTiOtzsm",
  "team_id": "tm_3b5335b627084a838b",
  "source_id": "src_q6z62b6py5o79b",
  "destination_id": "des_TU9ioCk5EHUU",
  "name": "invoices",
  "description": "Route invoice events to billing API",
  "disabled_at": null,
  "updated_at": "2026-05-10T18:02:15.441Z",
  "created_at": "2026-01-14T13:36:41.595Z",
  "paused_at": null,
  "rules": [
    {
      "type": "retry",
      "strategy": "exponential",
      "interval": 1000,
      "count": 5,
      "response_status_codes": [
        "500-599",
        "!501"
      ]
    }
  ],
  "destination": {
    "id": "des_TU9ioCk5EHUU",
    "team_id": "tm_3b5335b627084a838b",
    "name": "Production API",
    "description": "Primary billing event consumer",
    "type": "HTTP",
    "config": {
      "url": "https://api.example.com/webhooks",
      "path": null,
      "rate_limit": null,
      "rate_limit_period": "second",
      "http_method": "POST",
      "path_forwarding_disabled": false,
      "auth_type": "FASTHOOK_SIGNATURE",
      "auth": {}
    },
    "disabled_at": null,
    "created_at": "2026-01-14T13:35:55.263Z",
    "updated_at": "2026-01-14T13:36:41.584Z"
  },
  "source": {
    "id": "src_q6z62b6py5o79b",
    "team_id": "tm_3b5335b627084a838b",
    "name": "Stripe",
    "description": "Stripe billing webhook source",
    "type": "WEBHOOK",
    "url": "https://hook-xxxxxx.fasthook.io/",
    "config": {
      "auth_type": "BASIC_AUTH",
      "auth": {
        "username": "stripe-webhook",
        "password": "secret-password"
      },
      "custom_response": {
        "content_type": "json",
        "body": "{\"received\":true}"
      },
      "allowed_http_methods": ["POST", "PUT", "PATCH", "DELETE"]
    },
    "disabled_at": null,
    "created_at": "2026-01-14T13:35:55.226Z",
    "updated_at": "2026-01-14T13:36:41.583Z"
  }
}

Disable a connection input parameters

Disable a connection accepts the route, header, query, and body inputs listed below.

Disable a connection path parameters

idstringRequired

Connection ID. Used by the Disable a connection operation.

Disable a connection notes

Both PUT and POST are accepted for this action.

Request

Shell

curl -X POST \
  "https://api.fasthook.io/v1/connections/web_nbbweTiOtzsm/disable" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "id": "web_nbbweTiOtzsm",
  "team_id": "tm_3b5335b627084a838b",
  "source_id": "src_q6z62b6py5o79b",
  "destination_id": "des_TU9ioCk5EHUU",
  "name": "invoices",
  "description": "Route invoice events to billing API",
  "disabled_at": "2026-05-10T18:00:00.000Z",
  "updated_at": "2026-05-10T18:00:00.000Z",
  "created_at": "2026-01-14T13:36:41.595Z",
  "paused_at": null,
  "rules": [
    {
      "type": "retry",
      "strategy": "exponential",
      "interval": 1000,
      "count": 5,
      "response_status_codes": [
        "500-599",
        "!501"
      ]
    }
  ],
  "destination": {
    "id": "des_TU9ioCk5EHUU",
    "team_id": "tm_3b5335b627084a838b",
    "name": "Production API",
    "description": "Primary billing event consumer",
    "type": "HTTP",
    "config": {
      "url": "https://api.example.com/webhooks",
      "path": null,
      "rate_limit": null,
      "rate_limit_period": "second",
      "http_method": "POST",
      "path_forwarding_disabled": false,
      "auth_type": "FASTHOOK_SIGNATURE",
      "auth": {}
    },
    "disabled_at": null,
    "created_at": "2026-01-14T13:35:55.263Z",
    "updated_at": "2026-01-14T13:36:41.584Z"
  },
  "source": {
    "id": "src_q6z62b6py5o79b",
    "team_id": "tm_3b5335b627084a838b",
    "name": "Stripe",
    "description": "Stripe billing webhook source",
    "type": "WEBHOOK",
    "url": "https://hook-xxxxxx.fasthook.io/",
    "config": {
      "auth_type": "BASIC_AUTH",
      "auth": {
        "username": "stripe-webhook",
        "password": "secret-password"
      },
      "custom_response": {
        "content_type": "json",
        "body": "{\"received\":true}"
      },
      "allowed_http_methods": ["POST", "PUT", "PATCH", "DELETE"]
    },
    "disabled_at": null,
    "created_at": "2026-01-14T13:35:55.226Z",
    "updated_at": "2026-01-14T13:36:41.583Z"
  }
}

Enable a connection input parameters

Enable a connection accepts the route, header, query, and body inputs listed below.

Enable a connection path parameters

idstringRequired

Connection ID. Used by the Enable a connection operation.

Enable a connection notes

Both PUT and POST are accepted for this action.

Request

Shell

curl -X POST \
  "https://api.fasthook.io/v1/connections/web_nbbweTiOtzsm/enable" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "id": "web_nbbweTiOtzsm",
  "team_id": "tm_3b5335b627084a838b",
  "source_id": "src_q6z62b6py5o79b",
  "destination_id": "des_TU9ioCk5EHUU",
  "name": "invoices",
  "description": "Route invoice events to billing API",
  "disabled_at": null,
  "updated_at": "2026-05-10T18:02:15.441Z",
  "created_at": "2026-01-14T13:36:41.595Z",
  "paused_at": null,
  "rules": [
    {
      "type": "retry",
      "strategy": "exponential",
      "interval": 1000,
      "count": 5,
      "response_status_codes": [
        "500-599",
        "!501"
      ]
    }
  ],
  "destination": {
    "id": "des_TU9ioCk5EHUU",
    "team_id": "tm_3b5335b627084a838b",
    "name": "Production API",
    "description": "Primary billing event consumer",
    "type": "HTTP",
    "config": {
      "url": "https://api.example.com/webhooks",
      "path": null,
      "rate_limit": null,
      "rate_limit_period": "second",
      "http_method": "POST",
      "path_forwarding_disabled": false,
      "auth_type": "FASTHOOK_SIGNATURE",
      "auth": {}
    },
    "disabled_at": null,
    "created_at": "2026-01-14T13:35:55.263Z",
    "updated_at": "2026-01-14T13:36:41.584Z"
  },
  "source": {
    "id": "src_q6z62b6py5o79b",
    "team_id": "tm_3b5335b627084a838b",
    "name": "Stripe",
    "description": "Stripe billing webhook source",
    "type": "WEBHOOK",
    "url": "https://hook-xxxxxx.fasthook.io/",
    "config": {
      "auth_type": "BASIC_AUTH",
      "auth": {
        "username": "stripe-webhook",
        "password": "secret-password"
      },
      "custom_response": {
        "content_type": "json",
        "body": "{\"received\":true}"
      },
      "allowed_http_methods": ["POST", "PUT", "PATCH", "DELETE"]
    },
    "disabled_at": null,
    "created_at": "2026-01-14T13:35:55.226Z",
    "updated_at": "2026-01-14T13:36:41.583Z"
  }
}

Delete a connection input parameters

Delete a connection accepts the route, header, query, and body inputs listed below.

Delete a connection path parameters

idstringRequired

Connection ID. Used by the Delete a connection operation.

Request

Shell

curl -X DELETE \
  "https://api.fasthook.io/v1/connections/web_nbbweTiOtzsm" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "id": "web_nbbweTiOtzsm",
  "deleted": true
}

Connection Rules

Rules live inside connection.rules and are evaluated in normalized order.

Connection Rules response fields

15 fields

Rule type that determines how FastHook evaluates or changes delivery behavior.

strategy

Retry scheduling strategy, such as exponential backoff.

interval

Base retry interval in milliseconds.

count

Maximum number of retry attempts for the retry rule.

response_status_codes

HTTP response status codes or ranges that trigger retry behavior.

delay

Delivery delay in milliseconds for delay rules.

headers

Header predicates used by filter or deduplication rules.

body

Body predicates used by filter or deduplication rules.

query

Query-string predicates used by filter rules.

path

Path predicate used by filter rules.

transformation_id

Saved transformation ID linked to a transform rule.

transformation

Inline transformation object that can be upserted and linked to the connection.

window

Deduplication window in milliseconds.

include_fields

Request fields included when building a deduplication key.

exclude_fields

Request fields excluded when building a deduplication key.

Rule payload input parameters

Rule payload accepts the route, header, query, and body inputs listed below.

Rule payload path parameters

idstringRequired

Connection ID. Used by the Rule payload operation.

Rule payload request body

rulesarrayOptional

Request parameter. Used by the Rule payload operation.

Rule payload notes

delay must be between 0 and 86400000 ms.
deduplicate.window must be between 1000 and 3600000 ms.
inline transformation objects are upserted into transformations and linked by transformation_id.

Request

Shell

curl -X PUT \
  "https://api.fasthook.io/v1/connections/web_nbbweTiOtzsm" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "rules": [
    {
      "type": "retry",
      "strategy": "exponential",
      "interval": 1000,
      "count": 5,
      "response_status_codes": ["500-599", "!501"]
    },
    {
      "type": "delay",
      "delay": 1000
    },
    {
      "type": "filter",
      "headers": {
        "x-provider": "stripe"
      },
      "body": {
        "type": "invoice.paid"
      },
      "query": {
        "mode": "live"
      },
      "path": {
        "$starts_with": "/stripe"
      }
    },
    {
      "type": "transform",
      "transformation_id": "trs_2jYb7sL8mN4pQ9rT"
    },
    {
      "type": "deduplicate",
      "window": 60000,
      "include_fields": ["body.id"]
    }
  ]
}'

Response

JSON

{
  "id": "web_nbbweTiOtzsm",
  "team_id": "tm_3b5335b627084a838b",
  "source_id": "src_q6z62b6py5o79b",
  "destination_id": "des_TU9ioCk5EHUU",
  "name": "invoices",
  "description": "Route invoice events to billing API",
  "rules": [
    {
      "type": "retry",
      "strategy": "exponential",
      "interval": 1000,
      "count": 5,
      "response_status_codes": ["500-599", "!501"]
    },
    {
      "type": "delay",
      "delay": 1000
    },
    {
      "type": "filter",
      "headers": {
        "x-provider": "stripe"
      },
      "body": {
        "type": "invoice.paid"
      },
      "query": {
        "mode": "live"
      },
      "path": {
        "$starts_with": "/stripe"
      }
    },
    {
      "type": "transform",
      "transformation_id": "trs_2jYb7sL8mN4pQ9rT"
    },
    {
      "type": "deduplicate",
      "window": 60000,
      "include_fields": ["body.id"]
    }
  ],
  "source": {
    "id": "src_q6z62b6py5o79b",
    "team_id": "tm_3b5335b627084a838b",
    "name": "Stripe",
    "description": "Stripe billing webhook source",
    "type": "WEBHOOK",
    "url": "https://hook-xxxxxx.fasthook.io/",
    "config": {
      "auth_type": "BASIC_AUTH",
      "auth": {
        "username": "stripe-webhook",
        "password": "secret-password"
      },
      "custom_response": {
        "content_type": "json",
        "body": "{\"received\":true}"
      },
      "allowed_http_methods": ["POST", "PUT", "PATCH", "DELETE"]
    },
    "disabled_at": null,
    "created_at": "2026-01-14T13:35:55.226Z",
    "updated_at": "2026-01-14T13:36:41.583Z"
  },
  "destination": {
    "id": "des_TU9ioCk5EHUU",
    "team_id": "tm_3b5335b627084a838b",
    "name": "Production API",
    "description": "Primary billing event consumer",
    "type": "HTTP",
    "config": {
      "url": "https://api.example.com/webhooks",
      "path": null,
      "rate_limit": null,
      "rate_limit_period": "second",
      "http_method": "POST",
      "path_forwarding_disabled": false,
      "auth_type": "FASTHOOK_SIGNATURE",
      "auth": {}
    },
    "disabled_at": null,
    "created_at": "2026-01-14T13:35:55.263Z",
    "updated_at": "2026-01-14T13:36:41.584Z"
  },
  "disabled_at": null,
  "paused_at": null,
  "created_at": "2026-01-14T13:36:41.595Z",
  "updated_at": "2026-05-10T18:13:08.334Z"
}

Project API Keys

Create independently revocable, least-privilege credentials for team automation. Raw key material is returned only by the create response.

Project API Keys response fields

14 fields

id

id field returned by the Project API Keys API.

name

name field returned by the Project API Keys API.

masked_key

masked_key field returned by the Project API Keys API.

statusactive | disabled | revoked

status field returned by the Project API Keys API.

scopescontrol:read | control:edit | control:execute

scopes field returned by the Project API Keys API.

execute_grants

execute_grants field returned by the Project API Keys API.

rate_limit_per_minute

rate_limit_per_minute field returned by the Project API Keys API.

last_used_at

last_used_at field returned by the Project API Keys API.

secret_last_rotated_at

secret_last_rotated_at field returned by the Project API Keys API.

legacy_project_secret

legacy_project_secret field returned by the Project API Keys API.

created_by_user_id

created_by_user_id field returned by the Project API Keys API.

revoked_at

revoked_at field returned by the Project API Keys API.

created_at

created_at field returned by the Project API Keys API.

updated_at

updated_at field returned by the Project API Keys API.

List project API keys input parameters

List project API keys does not require path, query, or body parameters.

Create a project API key input parameters

Create a project API key accepts the route, header, query, and body inputs listed below.

Create a project API key request body

namestringRequired

required, 1 to 100 characters Used by the Create a project API key operation.

scopesarrayRequired

required unique array of control:read, control:edit, and control:execute Used by the Create a project API key operation.

execute_grantsstringOptional

optional resource restrictions; requires control:execute Used by the Create a project API key operation.

rate_limit_per_minuteintegerOptional

optional integer from 1 to 10000 Used by the Create a project API key operation.

Create a project API key notes

POST returns 201 with Cache-Control: no-store. Store the raw key before leaving the response.

Request

Shell

curl -X POST \
  "https://api.fasthook.io/v1/project-api-keys" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "name": "production deploy",
  "scopes": ["control:read", "control:edit"],
  "rate_limit_per_minute": 120
}'

Response

JSON

{
  "data": {
    "api_key": "fhp_copy_this_value_once",
    "id": "pak_01jv8d9m7q4r2x6p3n5k1s0t8b",
    "team_id": "tm_3b5335b627084a838b",
    "name": "production deploy",
    "masked_key": "fhp_copy************once",
    "status": "active",
    "scopes": ["control:read", "control:edit"],
    "execute_grants": [],
    "rate_limit_per_minute": 120,
    "legacy_project_secret": false,
    "created_by_user_id": "usr_01jv8d7p3x2r9m6n4k1s0t5q8b",
    "last_used_at": null,
    "secret_last_rotated_at": "2026-09-13T17:00:00.000Z",
    "revoked_at": null,
    "created_at": "2026-09-13T17:00:00.000Z",
    "updated_at": "2026-09-13T17:00:00.000Z"
  }
}

Retrieve or update a project API key input parameters

Retrieve or update a project API key accepts the route, header, query, and body inputs listed below.

Retrieve or update a project API key path parameters

keyIdstringRequired

Resource ID from the route. Used by the Retrieve or update a project API key operation.

Retrieve or update a project API key request body

name, status, scopes, execute_grants, and rate_limit_per_minute are optionalstringOptional

Request parameter. Used by the Retrieve or update a project API key operation.

Retrieve or update a project API key notes

Revoked keys cannot be changed.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/project-api-keys/%3CkeyId%3E" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "status": "disabled",
  "rate_limit_per_minute": 60
}'

Response

JSON

{
  "data": {
    "id": "pak_01jv8d9m7q4r2x6p3n5k1s0t8b",
    "team_id": "tm_3b5335b627084a838b",
    "name": "production deploy",
    "masked_key": "fhp_copy************once",
    "status": "disabled",
    "scopes": ["control:read", "control:edit"],
    "execute_grants": [],
    "rate_limit_per_minute": 60,
    "legacy_project_secret": false,
    "created_by_user_id": "usr_01jv8d7p3x2r9m6n4k1s0t5q8b",
    "last_used_at": null,
    "secret_last_rotated_at": "2026-09-13T17:00:00.000Z",
    "revoked_at": null,
    "created_at": "2026-09-13T17:00:00.000Z",
    "updated_at": "2026-09-13T18:00:00.000Z"
  }
}

Permanently revoke a project API key input parameters

Permanently revoke a project API key accepts the route, header, query, and body inputs listed below.

Permanently revoke a project API key path parameters

keyIdstringRequired

Resource ID from the route. Used by the Permanently revoke a project API key operation.

Request

Shell

curl -X DELETE \
  "https://api.fasthook.io/v1/project-api-keys/%3CkeyId%3E" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "data": {
    "id": "pak_01jv8d9m7q4r2x6p3n5k1s0t8b",
    "team_id": "tm_3b5335b627084a838b",
    "name": "production deploy",
    "masked_key": "fhp_copy************once",
    "status": "revoked",
    "scopes": ["control:read", "control:edit"],
    "execute_grants": [],
    "rate_limit_per_minute": 60,
    "legacy_project_secret": false,
    "created_by_user_id": "usr_01jv8d7p3x2r9m6n4k1s0t5q8b",
    "last_used_at": null,
    "secret_last_rotated_at": "2026-09-13T17:00:00.000Z",
    "revoked_at": "2026-09-13T18:00:00.000Z",
    "created_at": "2026-09-13T17:00:00.000Z",
    "updated_at": "2026-09-13T18:00:00.000Z"
  }
}

Permanently revoke a project API key input parameters

Permanently revoke a project API key accepts the route, header, query, and body inputs listed below.

Permanently revoke a project API key path parameters

keyIdstringRequired

Resource ID from the route. Used by the Permanently revoke a project API key operation.

Request

Shell

curl -X POST \
  "https://api.fasthook.io/v1/project-api-keys/%3CkeyId%3E/revoke" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "data": {
    "id": "pak_01jv8d9m7q4r2x6p3n5k1s0t8b",
    "team_id": "tm_3b5335b627084a838b",
    "name": "production deploy",
    "masked_key": "fhp_copy************once",
    "status": "revoked",
    "scopes": ["control:read", "control:edit"],
    "execute_grants": [],
    "rate_limit_per_minute": 60,
    "legacy_project_secret": false,
    "created_by_user_id": "usr_01jv8d7p3x2r9m6n4k1s0t5q8b",
    "last_used_at": null,
    "secret_last_rotated_at": "2026-09-13T17:00:00.000Z",
    "revoked_at": "2026-09-13T18:00:00.000Z",
    "created_at": "2026-09-13T17:00:00.000Z",
    "updated_at": "2026-09-13T18:00:00.000Z"
  }
}

List project API key audit decisions input parameters

List project API key audit decisions accepts the route, header, query, and body inputs listed below.

List project API key audit decisions path parameters

keyIdstringRequired

Resource ID from the route. Used by the List project API key audit decisions operation.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/project-api-keys/%3CkeyId%3E/audit" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "data": [
    {
      "id": 42,
      "key_id": "pak_01jv8d9m7q4r2x6p3n5k1s0t8b",
      "team_id": "tm_3b5335b627084a838b",
      "route_key": "GET:/v1/sources",
      "decision": "allow",
      "permission": "read",
      "reason": "scope_allowed",
      "cf_ray": null,
      "created_at": "2026-09-13T18:00:00.000Z"
    }
  ]
}

Project Secrets

Project secrets provide API access and outbound signature verification for a team.

Project Secrets response fields

11 fields

team_id

Team that owns the project secrets.

created_at

ISO timestamp when the secret pair was created.

updated_at

ISO timestamp when either secret was last changed.

api_key.value

New project API key, present only in a successful rotation response for this field.

api_key.masked_value

Redacted API key display value.

api_key.has_secret

Whether an API key is configured.

api_key.last_rotated_at

ISO timestamp when the API key was last rotated.

signing_secret.value

New signing secret, present only in a successful rotation response for this field.

signing_secret.masked_value

Redacted signing secret display value.

signing_secret.has_secret

Whether a signing secret is configured.

signing_secret.last_rotated_at

ISO timestamp when the signing secret was last rotated.

Get project secrets input parameters

Get project secrets does not require path, query, or body parameters.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/project-secrets" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "team_id": "tm_3b5335b627084a838b",
  "created_at": "2026-01-14T13:36:41.701Z",
  "updated_at": "2026-01-14T13:36:41.702Z",
  "api_key": {
    "masked_value": "fhp************04ad",
    "has_secret": true,
    "last_rotated_at": "2026-01-14T13:36:41.701Z"
  },
  "signing_secret": {
    "masked_value": "fhs************38fb",
    "has_secret": true,
    "last_rotated_at": "2026-01-14T13:36:41.702Z"
  }
}

Update project secrets input parameters

Update project secrets accepts the route, header, query, and body inputs listed below.

Update project secrets request body

api_keystringOptional

optional API key string with at least 12 characters Used by the Update project secrets operation.

signing_secretstringOptional

optional signing secret string with at least 12 characters Used by the Update project secrets operation.

Update project secrets notes

At least one of api_key or signing_secret is required.

Request

Shell

curl -X PUT \
  "https://api.fasthook.io/v1/project-secrets" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "api_key": "fhp_custom_secret",
  "signing_secret": "fhsig_custom_secret"
}'

Response

JSON

{
  "team_id": "tm_3b5335b627084a838b",
  "created_at": "2026-01-14T13:36:41.701Z",
  "updated_at": "2026-05-10T18:15:00.000Z",
  "api_key": {
    "masked_value": "fhp************cret",
    "has_secret": true,
    "last_rotated_at": "2026-05-10T18:15:00.000Z"
  },
  "signing_secret": {
    "masked_value": "fhs************cret",
    "has_secret": true,
    "last_rotated_at": "2026-05-10T18:15:00.000Z"
  }
}

Rotate project secrets input parameters

Rotate project secrets accepts the route, header, query, and body inputs listed below.

Rotate project secrets request body

rotatearrayOptional

optional array of api_key and signing_secret Used by the Rotate project secrets operation.

Rotate project secrets notes

Empty body rotates both secrets.
Use rotate=["signing_secret"] to rotate only the signing secret.
Copy each returned value immediately; subsequent GET requests expose masked metadata only.

Request

Shell

curl -X POST \
  "https://api.fasthook.io/v1/project-secrets/rotate" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "rotate": ["api_key", "signing_secret"]
}'

Response

JSON

{
  "team_id": "tm_3b5335b627084a838b",
  "created_at": "2026-01-14T13:36:41.701Z",
  "updated_at": "2026-05-10T18:16:22.504Z",
  "api_key": {
    "value": "fhp_live_01jv8c6m2p9x4r7t1n0k8s5q3b",
    "masked_value": "fhp************9a1b",
    "has_secret": true,
    "last_rotated_at": "2026-05-10T18:16:22.504Z"
  },
  "signing_secret": {
    "value": "fhsig_live_01jv8c6z7p2x9r4t1n0k8s5m",
    "masked_value": "fhs************42ce",
    "has_secret": true,
    "last_rotated_at": "2026-05-10T18:16:22.504Z"
  }
}

Public Request Bins

Public request bins provide temporary no-login webhook URLs with private read tokens, one-hour cleanup, optional account claiming, and a live request stream.

Public Request Bins response fields

8 fields

idsrc_*

Temporary bin source ID. Public bin IDs use the src_ prefix.

endpoint

Public hook URL that receives webhook requests for the bin.

tokenpbn_*

Private pbn_ read token returned only when the public bin is created.

expires_at

ISO timestamp when an unclaimed public bin expires.

ttl_seconds

Lifetime of the anonymous bin in seconds.

requests[].id

Captured inbound request ID.

requests[].status

Acceptance or rejection status for the captured request.

requests[].data

Captured headers, body, query, path, and HTTP method.

Create a public request bin input parameters

Create a public request bin does not require path, query, or body parameters.

Create a public request bin notes

The token is returned once and is required to read or claim the bin.
Anonymous bin creation is rate limited and bins are automatically cleaned up after one hour.

Request

Shell

curl -X POST \
  "https://api.fasthook.io/v1/public-bins"

Response

JSON

{
  "id": "src_01jv8cg7p3r6t2x9q5m1k4s0n8",
  "endpoint": "https://hook-fvibzj.fasthook.io/",
  "token": "pbn_01jv8ch4q7r2t6x9m3k5s1n0p8",
  "expires_at": "2026-07-18T09:40:00.000Z",
  "ttl_seconds": 3600
}

Read a public request bin input parameters

Read a public request bin accepts the route, header, query, and body inputs listed below.

Read a public request bin path parameters

idstringRequired

Public request bin source ID. Used by the Read a public request bin operation.

Read a public request bin headers

x-bin-tokenstringRequired

Private read token returned when the bin was created. Used by the Read a public request bin operation.

Read a public request bin notes

Responses use Cache-Control: no-store.
Expired bins return 410 Gone.

Request

Shell

curl -X GET "https://api.fasthook.io/v1/public-bins/src_01jv8cg7p3r6t2x9q5m1k4s0n8" \
  -H "x-bin-token: pbn_01jv8ch4q7r2t6x9m3k5s1n0p8"

Response

JSON

{
  "count": 1,
  "models": [
    {
      "id": "req_01jv8c3m7b2p4q9x6r5t1n0k8s",
      "status": "accepted",
      "verified": false,
      "source_id": "src_01jv8cg7p3r6t2x9q5m1k4s0n8",
      "ingested_at": "2026-07-18T08:42:11.000Z",
      "data": {
        "headers": {
          "content-type": "application/json"
        },
        "body": {
          "type": "order.created",
          "id": "evt_demo_001"
        },
        "query": {},
        "path": "/",
        "method": "POST"
      }
    }
  ]
}

Claim a public request bin input parameters

Claim a public request bin accepts the route, header, query, and body inputs listed below.

Claim a public request bin path parameters

idstringRequired

Public request bin source ID. Used by the Claim a public request bin operation.

Claim a public request bin headers

x-bin-tokenstringRequired

Private read token returned when the bin was created. Used by the Claim a public request bin operation.

Claim a public request bin notes

Claiming preserves captured requests and turns the temporary bin into a team-owned source.

Request

Shell

curl -X POST "https://api.fasthook.io/v1/public-bins/src_01jv8cg7p3r6t2x9q5m1k4s0n8/claim" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "x-bin-token: pbn_01jv8ch4q7r2t6x9m3k5s1n0p8"

Response

JSON

{
  "id": "src_01jv8cg7p3r6t2x9q5m1k4s0n8",
  "source_id": "src_01jv8cg7p3r6t2x9q5m1k4s0n8",
  "endpoint": "https://hook-fvibzj.fasthook.io/",
  "team_id": "tm_3b5335b627084a838b",
  "claimed_at": "2026-07-18T08:48:20.000Z",
  "migrated_requests": 3,
  "already_claimed": false
}

Stream bin requests input parameters

Stream bin requests accepts the route, header, query, and body inputs listed below.

Stream bin requests path parameters

idstringRequired

Resource ID from the route. Used by the Stream bin requests operation.

Stream bin requests headers

UpgradestringRequired

Required WebSocket upgrade header. Used by the Stream bin requests operation.

Sec-WebSocket-ProtocolstringOptional

Optional fh_token.<base64url> and fh_team.<base64url> protocol values for browser WebSocket authentication. Used by the Stream bin requests operation.

Stream bin requests notes

A non-WebSocket request returns 426 Upgrade Required.
Browser clients can pass credentials through Sec-WebSocket-Protocol using fh_token and fh_team values.

Request

Shell

curl --http1.1 "https://api.fasthook.io/v1/bins/src_01jv8cg7p3r6t2x9q5m1k4s0n8/stream" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "Connection: Upgrade" \
  -H "Upgrade: websocket" \
  -H "Sec-WebSocket-Version: 13" \
  -H "Sec-WebSocket-Key: SGVsbG9GYXN0SG9vaw=="

Response

Text

HTTP/1.1 101 Switching Protocols
Upgrade: websocket
Connection: Upgrade

Requests

Requests are inbound webhook deliveries received by FastHook.

Requests response fields

19 fields

idreq_*

Unique inbound request ID. Request IDs use the req_ prefix.

team_id

Team that owns the inbound request.

statusaccepted | rejected

Inbound request outcome derived from acceptance or rejection.

verified

Whether the inbound request passed source verification.

original_event_data_id

Stored payload record containing the original inbound request data.

rejection_cause

Reason the request was rejected, or null when accepted.

ingested_at

ISO timestamp when FastHook received the inbound webhook request.

source_id

Source that received the inbound webhook request.

events_count

Number of outbound events created from the request.

ignored_count

Number of routed events ignored by filtering or rule evaluation.

cli_events_count

Number of local CLI tunnel deliveries created from the request.

is_retry

Whether the request was created by replaying a previous request.

retry_kindsingle | bulk

Retry origin, such as single replay or bulk replay.

retry_parent_request_id

Original request ID when this request was created by a retry.

retry_operation_id

Bulk operation ID that created the retry request, when applicable.

retried_at

ISO timestamp when the request was replayed.

data

Stored inbound request payload, headers, method, path, query, and body when included.

created_at

ISO timestamp when the request record was created.

updated_at

ISO timestamp when the request record was last changed.

List requests input parameters

List requests accepts the route, header, query, and body inputs listed below.

List requests query parameters

fromdatetimeOptional

ISO datetime or relative time for the start of the request window Used by the List requests operation.

todatetimeOptional

ISO datetime or relative time for the end of the request window Used by the List requests operation.

limitintegerOptional

default 100, max 100 Used by the List requests operation.

cursorstringOptional

opaque next_cursor or next value Used by the List requests operation.

statusenumOptional

accepted | rejected Used by the List requests operation.

verifiedbooleanOptional

true | false Used by the List requests operation.

source_idstringOptional

Source ID used to filter inbound requests or routed events. Used by the List requests operation.

connection_idstringOptional

Connection ID used to filter routed requests or events. Used by the List requests operation.

batch_operation_idstringOptional

Bulk operation ID used to filter matching requests or events. Used by the List requests operation.

is_retrybooleanOptional

true | false Used by the List requests operation.

retry_kindenumOptional

single | bulk Used by the List requests operation.

q or search_termstringOptional

search across id and external_id Used by the List requests operation.

includestringOptional

data, optional stored payload data Used by the List requests operation.

List requests notes

For request listings, total is exact and total_exact is true when next_cursor is null.
When next_cursor is present, total is a lower bound for the current query; use /v1/requests/count for an exact total.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/requests?from=2026-04-17T00%3A00%3A00.000Z&to=2026-04-17T23%3A59%3A59.999Z&limit=100&cursor=cur_01jv8c4n9p3x7r2t6q5m1k0s8b&status=accepted&verified=true&source_id=src_q6z62b6py5o79b&connection_id=web_nbbweTiOtzsm&batch_operation_id=bch_01jv8c9p4q6r2t7x1n0k5m8s3b&is_retry=false&retry_kind=single&q=stripe" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "total": 1,
  "total_exact": true,
  "limit": 100,
  "applied_range": {
    "from": "2026-04-17T00:00:00.000Z",
    "to": "2026-04-17T23:59:59.999Z"
  },
  "next_cursor": null,
  "next": null,
  "prev": null,
  "pagination": {
    "order_by": "ingested_at",
    "dir": "desc",
    "limit": 100
  },
  "count": 1,
  "models": [
    {
      "id": "req_01jv8c3m7b2p4q9x6r5t1n0k8s",
      "team_id": "tm_3b5335b627084a838b",
      "status": "accepted",
      "verified": true,
      "original_event_data_id": "evd_01jv8c3m7b2p4q9x6r5t1n0k8s",
      "rejection_cause": null,
      "ingested_at": "2026-04-17T00:00:00.000Z",
      "source_id": "src_q6z62b6py5o79b",
      "events_count": 2,
      "ignored_count": 0,
      "cli_events_count": 0,
      "is_retry": false,
      "retry_kind": null,
      "retry_parent_request_id": null,
      "retry_operation_id": null,
      "retried_at": null,
      "updated_at": "2026-04-17T00:00:03.000Z",
      "created_at": "2026-04-17T00:00:00.000Z"
    }
  ]
}

Count requests input parameters

Count requests accepts the route, header, query, and body inputs listed below.

Count requests query parameters

from or ingested_at[gte]datetimeOptional

ISO datetime or relative lower bound for request ingestion Used by the Count requests operation.

to or ingested_at[lte]datetimeOptional

ISO datetime or relative upper bound for request ingestion Used by the Count requests operation.

statusenumOptional

accepted | rejected Used by the Count requests operation.

verifiedbooleanOptional

true | false Used by the Count requests operation.

source_idstringOptional

Source ID used to filter inbound requests or routed events. Used by the Count requests operation.

connection_idstringOptional

Connection ID used to filter routed requests or events. Used by the Count requests operation.

batch_operation_idstringOptional

Bulk operation ID used to filter matching requests or events. Used by the Count requests operation.

is_retrybooleanOptional

true | false Used by the Count requests operation.

retry_kindenumOptional

single | bulk Used by the Count requests operation.

q or search_termstringOptional

Text search query; search_term is accepted as an alias. Used by the Count requests operation.

Request

Shell

curl "https://api.fasthook.io/v1/requests/count?from=2026-04-17T00%3A00%3A00.000Z&to=2026-04-17T23%3A59%3A59.999Z&status=accepted&verified=true&source_id=src_q6z62b6py5o79b&connection_id=web_nbbweTiOtzsm&batch_operation_id=bch_01jv8c9p4q6r2t7x1n0k5m8s3b&is_retry=false&retry_kind=single&q=stripe" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "total": 1234,
  "count": 1234,
  "total_exact": true,
  "applied_range": {
    "from": "2026-04-17T00:00:00.000Z",
    "to": "2026-04-17T23:59:59.999Z"
  }
}

Retrieve a request input parameters

Retrieve a request accepts the route, header, query, and body inputs listed below.

Retrieve a request path parameters

idstringRequired

Request ID. Used by the Retrieve a request operation.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/requests/req_01jv8c3m7b2p4q9x6r5t1n0k8s" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "id": "req_01jv8c3m7b2p4q9x6r5t1n0k8s",
  "team_id": "tm_3b5335b627084a838b",
  "status": "accepted",
  "verified": true,
  "original_event_data_id": "evd_01jv8c3m7b2p4q9x6r5t1n0k8s",
  "rejection_cause": null,
  "ingested_at": "2026-04-17T00:00:00.000Z",
  "source_id": "src_q6z62b6py5o79b",
  "events_count": 2,
  "ignored_count": 0,
  "cli_events_count": 0,
  "is_retry": false,
  "retry_kind": null,
  "retry_parent_request_id": null,
  "retry_operation_id": null,
  "retried_at": null,
  "updated_at": "2026-04-17T00:00:03.000Z",
  "created_at": "2026-04-17T00:00:00.000Z",
  "data": {
    "path": "/",
    "query": "",
    "parsed_query": {},
    "headers": {
      "content-type": "application/json",
      "stripe-signature": "t=1765303200,v1=8aab0c2b25d4f5d66118863b1b8a4f31"
    },
    "body": {
      "id": "evt_stripe_01jv8c3m",
      "type": "invoice.paid",
      "data": {
        "object": {
          "id": "in_01jv8c3m",
          "amount_paid": 4900,
          "currency": "usd"
        }
      }
    },
    "method": "POST",
    "is_large_payload": true
  }
}

Retrieve request trace input parameters

Retrieve request trace accepts the route, header, query, and body inputs listed below.

Retrieve request trace path parameters

idstringRequired

Request ID. Used by the Retrieve request trace operation.

Retrieve request trace notes

Use this endpoint when you need the whole request path in one call instead of fetching request, events, ignored events, attempts, and transformations separately.
The request.data object contains the original stored inbound payload. Event payload ids and transformation payload ids show where the outbound data changed.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/requests/req_01jv8c3m7b2p4q9x6r5t1n0k8s/trace" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "request": {
    "id": "req_01jv8c3m7b2p4q9x6r5t1n0k8s",
    "team_id": "tm_3b5335b627084a838b",
    "status": "accepted",
    "verified": true,
    "source_id": "src_q6z62b6py5o79b",
    "original_event_data_id": "evd_01jv8c3m7b2p4q9x6r5t1n0k8s",
    "ingested_at": "2026-04-17T00:00:00.000Z",
    "events_count": 2,
    "ignored_count": 1,
    "data": {
      "method": "POST",
      "path": "/stripe",
      "query": "",
      "headers": {
        "content-type": "application/json"
      },
      "body": {
        "type": "invoice.paid"
      }
    }
  },
  "events": [
    {
      "id": "evt_01jv8c4n9p3x7r2t6q5m1k0s8b",
      "connection_id": "web_nbbweTiOtzsm",
      "destination_id": "des_TU9ioCk5EHUU",
      "event_data_id": "evd_transformed_01jv8c4n",
      "status": "SUCCESSFUL",
      "attempts": 1,
      "response_status": 200,
      "created_at": "2026-04-17T00:00:02.000Z"
    }
  ],
  "ignored_events": [
    {
      "id": "req_01jv8c3m7b2p4q9x6r5t1n0k8s:web_filtered",
      "cause": "FILTERED",
      "request_id": "req_01jv8c3m7b2p4q9x6r5t1n0k8s"
    }
  ],
  "attempts_by_event_id": {
    "evt_01jv8c4n9p3x7r2t6q5m1k0s8b": [
      {
        "id": "att_01jv8cdq6r2t5x9q4m1k0s7p3b",
        "status": "SUCCESSFUL",
        "response_status": 200,
        "requested_url": "https://api.example.com/webhooks",
        "body": {
          "ok": true
        }
      }
    ]
  },
  "transformations_by_event_id": {
    "evt_01jv8c4n9p3x7r2t6q5m1k0s8b": [
      {
        "id": "txe_01jv8c1h3z7r6b5n4m2k9q8p0x",
        "transformation_id": "trs_2jYb7sL8mN4pQ9rT",
        "log_level": "info",
        "original_event_data": {
          "body": {
            "type": "invoice.paid"
          }
        },
        "transformed_event_data": {
          "body": {
            "type": "invoice.paid",
            "normalized": true
          }
        }
      }
    ]
  },
  "timeline": [
    {
      "kind": "request.received",
      "label": "Request accepted at source",
      "at": "2026-04-17T00:00:00.000Z",
      "status": "accepted",
      "request_id": "req_01jv8c3m7b2p4q9x6r5t1n0k8s"
    },
    {
      "kind": "event.successful",
      "label": "Event SUCCESSFUL",
      "at": "2026-04-17T00:00:02.000Z",
      "event_id": "evt_01jv8c4n9p3x7r2t6q5m1k0s8b"
    },
    {
      "kind": "attempt.successful",
      "label": "Attempt 1 SUCCESSFUL",
      "at": "2026-04-17T00:00:03.000Z",
      "attempt_id": "att_01jv8cdq6r2t5x9q4m1k0s7p3b"
    }
  ],
  "counts": {
    "events": 1,
    "ignored_events": 1,
    "attempts": 1,
    "transformations": 1
  }
}

Create a sanitized request share input parameters

Create a sanitized request share accepts the route, header, query, and body inputs listed below.

Create a sanitized request share path parameters

idstringRequired

Request ID. Used by the Create a sanitized request share operation.

Create a sanitized request share request body

titlestringOptional

optional short label for the share Used by the Create a sanitized request share operation.

expires_in_seconds, ttl_seconds, or ttlstringOptional

optional TTL in seconds; default 7 days, max 30 days Used by the Create a sanitized request share operation.

expires_atdatetimeOptional

optional ISO datetime; clamped to the maximum TTL Used by the Create a sanitized request share operation.

redact_keys or redactKeysarrayOptional

optional array of additional header, query, or body keys to redact Used by the Create a sanitized request share operation.

include_bodybooleanOptional

optional boolean; set false to omit body content Used by the Create a sanitized request share operation.

Request

Shell

curl -X POST "https://api.fasthook.io/v1/requests/req_01jv8c3m7b2p4q9x6r5t1n0k8s/share" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "content-type: application/json" \
  --data '{
    "title": "Support case 1842",
    "expires_in_seconds": 604800,
    "redact_keys": ["customer_id", "account_number"]
  }'

Response

JSON

{
  "id": "shr_8d31a4d0ed58f2259e2a30d1",
  "token": "rsh_9349d0c2f5f9f4ab6721a77f37bba274af4bfa4f4318e9ac",
  "team_id": "tm_3b5335b627084a838b",
  "request_id": "req_01jv8c3m7b2p4q9x6r5t1n0k8s",
  "source_id": "src_q6z62b6py5o79b",
  "title": "Support case 1842",
  "url": "https://dashboard.fasthook.io/share/requests/rsh_9349d0c2f5f9f4ab6721a77f37bba274af4bfa4f4318e9ac",
  "share_url": "https://dashboard.fasthook.io/share/requests/rsh_9349d0c2f5f9f4ab6721a77f37bba274af4bfa4f4318e9ac",
  "expires_at": "2026-05-17T18:18:42.184Z",
  "revoked_at": null,
  "access_count": 0,
  "last_accessed_at": null,
  "sanitized": true,
  "request": {
    "id": "req_01jv8c3m7b2p4q9x6r5t1n0k8s",
    "status": "accepted",
    "verified": true,
    "source_id": "src_q6z62b6py5o79b",
    "method": "POST",
    "path": "/",
    "query": "",
    "url": "/",
    "headers": {
      "authorization": "[redacted]",
      "content-type": "application/json"
    },
    "parsed_query": {},
    "body": {
      "customer_id": "[redacted]",
      "type": "invoice.paid"
    },
    "body_truncated": false
  }
}

Retrieve a sanitized request share input parameters

Retrieve a sanitized request share accepts the route, header, query, and body inputs listed below.

Retrieve a sanitized request share path parameters

tokenstringRequired

Resource ID from the route. Used by the Retrieve a sanitized request share operation.

Retrieve a sanitized request share notes

Expired, revoked, missing, or malformed tokens return 404 or 410.
The response contains the sanitized snapshot only, not the original stored request payload.

Request

Shell

curl "https://api.fasthook.io/v1/shares/request/rsh_9349d0c2f5f9f4ab6721a77f37bba274af4bfa4f4318e9ac"

Response

JSON

{
  "id": "shr_8d31a4d0ed58f2259e2a30d1",
  "token": "rsh_9349d0c2f5f9f4ab6721a77f37bba274af4bfa4f4318e9ac",
  "request_id": "req_01jv8c3m7b2p4q9x6r5t1n0k8s",
  "source_id": "src_q6z62b6py5o79b",
  "expires_at": "2026-05-17T18:18:42.184Z",
  "sanitized": true,
  "request": {
    "id": "req_01jv8c3m7b2p4q9x6r5t1n0k8s",
    "method": "POST",
    "url": "/",
    "headers": {
      "authorization": "[redacted]",
      "content-type": "application/json"
    },
    "body": {
      "customer_id": "[redacted]",
      "type": "invoice.paid"
    }
  }
}

Retry a request input parameters

Retry a request accepts the route, header, query, and body inputs listed below.

Retry a request path parameters

idstringRequired

Request ID. Used by the Retry a request operation.

Retry a request request body

modifications.methodstringOptional

optional HTTP method override Used by the Retry a request operation.

modifications.pathstringOptional

optional request path override Used by the Retry a request operation.

modifications.queryobjectOptional

optional query string or object override Used by the Retry a request operation.

modifications.headersobjectOptional

optional object of replay headers Used by the Retry a request operation.

modifications.bodystringOptional

optional replay body string or JSON value Used by the Retry a request operation.

Request

Shell

curl -X POST "https://api.fasthook.io/v1/requests/req_01jv8c3m7b2p4q9x6r5t1n0k8s/retry" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "content-type: application/json" \
  --data '{
    "modifications": {
      "method": "POST",
      "path": "/stripe/replay-test",
      "query": "dry_run=true",
      "headers": {
        "content-type": "application/json",
        "x-debug-replay": "true"
      },
      "body": "{\"type\":\"invoice.paid\",\"replay_test\":true}"
    }
  }'

Response

JSON

{
  "ok": true,
  "queued": true,
  "transport": "queue",
  "replayed_at": "2026-05-10T18:18:42.184Z",
  "request_id": "req_01jv8c3m7b2p4q9x6r5t1n0k8s",
  "source_id": "src_q6z62b6py5o79b",
  "replay_message_id": "msg_01jv8c8z2m6p4q7r9t1n0k5x3s",
  "replay_mode": "modified",
  "original_rejection_cause": null
}

List request events input parameters

List request events accepts the route, header, query, and body inputs listed below.

List request events path parameters

idstringRequired

Request ID. Used by the List request events operation.

List request events query parameters

statusenumOptional

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/requests/req_01jv8c3m7b2p4q9x6r5t1n0k8s/events?status=accepted" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "pagination": {
    "order_by": "created_at",
    "dir": "desc",
    "limit": 100
  },
  "next": null,
  "prev": null,
  "count": 1,
  "models": [
    {
      "id": "evt_01jv8c4n9p3x7r2t6q5m1k0s8b",
      "team_id": "tm_3b5335b627084a838b",
      "webhook_id": "web_nbbweTiOtzsm",
      "source_id": "src_q6z62b6py5o79b",
      "destination_id": "des_TU9ioCk5EHUU",
      "attempts": 1,
      "response_status": 200,
      "last_attempt_at": "2026-04-17T00:00:03.000Z",
      "next_attempt_at": null,
      "successful_at": "2026-04-17T00:00:03.000Z",
      "updated_at": "2026-04-17T00:00:03.000Z",
      "created_at": "2026-04-17T00:00:02.000Z",
      "status": "SUCCESSFUL",
      "event_data_id": "evd_01jv8c4n9p3x7r2t6q5m1k0s8b",
      "cli_id": null,
      "request_id": "req_01jv8c3m7b2p4q9x6r5t1n0k8s",
      "error_code": null
    }
  ]
}

List ignored request events input parameters

List ignored request events accepts the route, header, query, and body inputs listed below.

List ignored request events path parameters

idstringRequired

Request ID. Used by the List ignored request events operation.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/requests/req_01jv8c3m7b2p4q9x6r5t1n0k8s/ignored_events" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "pagination": {
    "order_by": "id",
    "dir": "asc",
    "limit": 100
  },
  "next": null,
  "prev": null,
  "count": 1,
  "models": [
    {
      "id": "req_01jv8c3m7b2p4q9x6r5t1n0k8s:web_nbbweTiOtzsm",
      "team_id": "tm_3b5335b627084a838b",
      "webhook_id": "web_nbbweTiOtzsm",
      "cause": "FILTERED",
      "request_id": "req_01jv8c3m7b2p4q9x6r5t1n0k8s",
      "meta": [],
      "created_at": "2026-04-17T00:00:02.000Z",
      "updated_at": "2026-04-17T00:00:02.000Z"
    }
  ]
}

List request bulk operations input parameters

List request bulk operations accepts the route, header, query, and body inputs listed below.

List request bulk operations query parameters

bucketenumOptional

all | ongoing | history Used by the List request bulk operations operation.

limitintegerOptional

Maximum number of records to return. Used by the List request bulk operations operation.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/requests/bulk_operations?bucket=all&limit=100" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "count": 1,
  "models": [
    {
      "id": "bch_01jv8c9p4q6r2t7x1n0k5m8s3b",
      "team_id": "tm_3b5335b627084a838b",
      "type": "request_bulk_retry",
      "status": "running",
      "filter": {
        "from": "2026-04-17T00:00:00.000Z",
        "to": "2026-04-17T23:59:59.999Z",
        "status": "rejected",
        "source_id": "src_q6z62b6py5o79b",
        "q": "stripe"
      },
      "requested_by": null,
      "created_at": "2026-05-10T18:20:00.000Z",
      "started_at": "2026-05-10T18:20:02.000Z",
      "finished_at": null,
      "total_count": 42,
      "queued_count": 42,
      "done_count": 17,
      "failed_count": 0,
      "cancelable": true
    }
  ]
}

Create request bulk operation input parameters

Create request bulk operation accepts the route, header, query, and body inputs listed below.

Create request bulk operation request body

fromdatetimeOptional

Lower bound for matching inbound requests; accepts an ISO datetime or a relative value such as now-1h Used by the Create request bulk operation operation.

todatetimeOptional

Upper bound for matching inbound requests; accepts an ISO datetime or a relative value such as now Used by the Create request bulk operation operation.

statusenumOptional

accepted | rejected Used by the Create request bulk operation operation.

source_idstringOptional

Source ID used to filter inbound requests or routed events. Used by the Create request bulk operation operation.

qstringOptional

Text search query. Used by the Create request bulk operation operation.

Request

Shell

curl -X POST \
  "https://api.fasthook.io/v1/requests/bulk_operations" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "from": "2026-04-17T00:00:00.000Z",
  "to": "2026-04-17T23:59:59.999Z",
  "status": "rejected",
  "source_id": "src_q6z62b6py5o79b",
  "q": "stripe"
}'

Response

JSON

{
  "id": "bch_01jv8c9p4q6r2t7x1n0k5m8s3b",
  "team_id": "tm_3b5335b627084a838b",
  "type": "request_bulk_retry",
  "status": "planned",
  "filter": {
    "from": "2026-04-17T00:00:00.000Z",
    "to": "2026-04-17T23:59:59.999Z",
    "status": "rejected",
    "source_id": "src_q6z62b6py5o79b",
    "q": "stripe"
  },
  "requested_by": null,
  "created_at": "2026-05-10T18:20:00.000Z",
  "started_at": null,
  "finished_at": null,
  "total_count": 42,
  "queued_count": 0,
  "done_count": 0,
  "failed_count": 0,
  "cancelable": true
}

Cancel request bulk operation input parameters

Cancel request bulk operation accepts the route, header, query, and body inputs listed below.

Cancel request bulk operation path parameters

idstringRequired

Bulk operation ID. Used by the Cancel request bulk operation operation.

Request

Shell

curl -X POST \
  "https://api.fasthook.io/v1/requests/bulk_operations/bch_01jv8c9p4q6r2t7x1n0k5m8s3b/cancel" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "id": "bch_01jv8c9p4q6r2t7x1n0k5m8s3b",
  "team_id": "tm_3b5335b627084a838b",
  "type": "request_bulk_retry",
  "status": "cancelled",
  "filter": {
    "from": "2026-04-17T00:00:00.000Z",
    "to": "2026-04-17T23:59:59.999Z",
    "status": "rejected",
    "source_id": "src_q6z62b6py5o79b",
    "q": "stripe"
  },
  "requested_by": null,
  "created_at": "2026-05-10T18:20:00.000Z",
  "started_at": "2026-05-10T18:20:02.000Z",
  "finished_at": "2026-05-10T18:22:13.333Z",
  "total_count": 42,
  "queued_count": 42,
  "done_count": 17,
  "failed_count": 0,
  "cancelable": false
}

Events

Events are outbound delivery records created from accepted requests.

Events response fields

28 fields

idevt_*

Unique outbound event ID. Event IDs use the evt_ prefix.

team_id

Team that owns the outbound event.

request_id

Inbound request that produced the outbound event.

connection_id

Connection that routed the event from source to destination.

webhook_id

Legacy alias for the connection ID.

source_id

Source that received the original inbound request.

destination_id

Destination selected for outbound delivery.

cli_id

CLI tunnel identifier when the event targets a local tunnel, otherwise null.

event_data_id

Stored payload record for the outbound event data.

Current delivery state of the outbound event.

rejection_cause

Reason the event was rejected before delivery, or null when not rejected.

failure_message

Human-readable failure message for failed delivery states.

ignored_reason

Reason the event was ignored by routing rules, or null when delivered.

ingested_at

ISO timestamp inherited from the inbound request ingestion time.

attempts

Number of delivery attempts made for this event.

response_status

HTTP status from the latest delivery response, when available.

last_attempt_at

ISO timestamp of the latest delivery attempt.

next_attempt_at

ISO timestamp when the next retry is scheduled, or null when none is scheduled.

successful_at

ISO timestamp when the event was delivered successfully.

error_code

Machine-readable error code for the latest failed attempt.

is_retry

Whether the event was created by retrying a previous event.

retry_kindsingle | bulk

Retry origin, such as single retry or bulk retry.

retry_parent_event_id

Original event ID when this event was created by a retry.

retry_operation_id

Bulk operation ID that created the retry event, when applicable.

retried_at

ISO timestamp when the event retry was queued.

data

Stored request and response payload data when included.

created_at

ISO timestamp when the event record was created.

updated_at

ISO timestamp when the event record was last changed.

List events input parameters

List events accepts the route, header, query, and body inputs listed below.

List events query parameters

fromdatetimeOptional

ISO datetime or relative time for the start of the event window Used by the List events operation.

todatetimeOptional

ISO datetime or relative time for the end of the event window Used by the List events operation.

limitintegerOptional

default 100, max 100 Used by the List events operation.

cursorstringOptional

opaque next_cursor or next value Used by the List events operation.

statusenumOptional

source_idstringOptional

Source ID used to filter inbound requests or routed events. Used by the List events operation.

connection_idstringOptional

Connection ID used to filter routed requests or events. Used by the List events operation.

destination_idstringOptional

Destination ID used to filter outbound events. Used by the List events operation.

batch_operation_idstringOptional

Bulk operation ID used to filter matching requests or events. Used by the List events operation.

q or search_termstringOptional

Text search query; search_term is accepted as an alias. Used by the List events operation.

List events notes

For event listings, total is exact and total_exact is true when next_cursor is null.
When next_cursor is present, total is a lower bound for the current query; use /v1/events/count for an exact total.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/events?from=2026-04-17T00%3A00%3A00.000Z&to=2026-04-17T23%3A59%3A59.999Z&limit=100&cursor=cur_01jv8c4n9p3x7r2t6q5m1k0s8b&status=delivered&source_id=src_q6z62b6py5o79b&connection_id=web_nbbweTiOtzsm&destination_id=des_TU9ioCk5EHUU&batch_operation_id=bch_01jv8c9p4q6r2t7x1n0k5m8s3b&q=invoice" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "total": 1,
  "total_exact": true,
  "limit": 100,
  "applied_range": {
    "from": "2026-04-17T00:00:00.000Z",
    "to": "2026-04-17T23:59:59.999Z"
  },
  "next_cursor": null,
  "next": null,
  "prev": null,
  "pagination": {
    "order_by": "ingested_at",
    "dir": "desc",
    "limit": 100
  },
  "count": 1,
  "models": [
    {
      "id": "evt_01jv8c4n9p3x7r2t6q5m1k0s8b",
      "team_id": "tm_3b5335b627084a838b",
      "request_id": "req_01jv8c3m7b2p4q9x6r5t1n0k8s",
      "connection_id": "web_nbbweTiOtzsm",
      "webhook_id": "web_nbbweTiOtzsm",
      "source_id": "src_q6z62b6py5o79b",
      "destination_id": "des_TU9ioCk5EHUU",
      "cli_id": null,
      "event_data_id": "evd_01jv8c4n9p3x7r2t6q5m1k0s8b",
      "status": "SUCCESSFUL",
      "rejection_cause": null,
      "failure_message": null,
      "ignored_reason": null,
      "ingested_at": "2026-04-17T00:00:00.000Z",
      "attempts": 1,
      "response_status": 200,
      "last_attempt_at": "2026-04-17T00:00:03.000Z",
      "next_attempt_at": null,
      "successful_at": "2026-04-17T00:00:03.000Z",
      "error_code": null,
      "is_retry": false,
      "retry_kind": null,
      "retry_parent_event_id": null,
      "retry_operation_id": null,
      "retried_at": null,
      "created_at": "2026-04-17T00:00:02.000Z",
      "updated_at": "2026-04-17T00:00:03.000Z"
    }
  ]
}

Count events input parameters

Count events accepts the route, header, query, and body inputs listed below.

Count events query parameters

from or ingested_at[gte]datetimeOptional

ISO datetime or relative lower bound for event ingestion Used by the Count events operation.

to or ingested_at[lte]datetimeOptional

ISO datetime or relative upper bound for event ingestion Used by the Count events operation.

statusenumOptional

source_idstringOptional

Source ID used to filter inbound requests or routed events. Used by the Count events operation.

connection_idstringOptional

Connection ID used to filter routed requests or events. Used by the Count events operation.

destination_idstringOptional

Destination ID used to filter outbound events. Used by the Count events operation.

batch_operation_idstringOptional

Bulk operation ID used to filter matching requests or events. Used by the Count events operation.

q or search_termstringOptional

Text search query; search_term is accepted as an alias. Used by the Count events operation.

Count events notes

Counts are evaluated against event records directly; source_id and destination_id are event fields.

Request

Shell

curl "https://api.fasthook.io/v1/events/count?from=2026-04-17T00%3A00%3A00.000Z&to=2026-04-17T23%3A59%3A59.999Z&status=SUCCESSFUL&source_id=src_q6z62b6py5o79b&connection_id=web_nbbweTiOtzsm&destination_id=des_TU9ioCk5EHUU&batch_operation_id=bch_01jv8ccp7q3r5t9x2n0k6m1s4b&q=invoice" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "total": 1234,
  "count": 1234,
  "total_exact": true,
  "applied_range": {
    "from": "2026-04-17T00:00:00.000Z",
    "to": "2026-04-17T23:59:59.999Z"
  }
}

Retrieve an event input parameters

Retrieve an event accepts the route, header, query, and body inputs listed below.

Retrieve an event path parameters

idstringRequired

Event ID. Used by the Retrieve an event operation.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/events/evt_01jv8c4n9p3x7r2t6q5m1k0s8b" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "id": "evt_01jv8c4n9p3x7r2t6q5m1k0s8b",
  "team_id": "tm_3b5335b627084a838b",
  "request_id": "req_01jv8c3m7b2p4q9x6r5t1n0k8s",
  "connection_id": "web_nbbweTiOtzsm",
  "webhook_id": "web_nbbweTiOtzsm",
  "source_id": "src_q6z62b6py5o79b",
  "destination_id": "des_TU9ioCk5EHUU",
  "cli_id": null,
  "event_data_id": "evd_01jv8c4n9p3x7r2t6q5m1k0s8b",
  "status": "SUCCESSFUL",
  "rejection_cause": null,
  "failure_message": null,
  "ignored_reason": null,
  "ingested_at": "2026-04-17T00:00:00.000Z",
  "attempts": 1,
  "response_status": 200,
  "last_attempt_at": "2026-04-17T00:00:03.000Z",
  "next_attempt_at": null,
  "successful_at": "2026-04-17T00:00:03.000Z",
  "error_code": null,
  "is_retry": false,
  "retry_kind": null,
  "retry_parent_event_id": null,
  "retry_operation_id": null,
  "retried_at": null,
  "data": {
    "request": {
      "headers": {
        "content-type": "application/json"
      },
      "body": {
        "id": "evt_stripe_01jv8c3m",
        "type": "invoice.paid"
      },
      "query": {},
      "path": "/",
      "method": "POST"
    },
    "response": {
      "status": 200,
      "headers": {
        "content-type": "application/json"
      },
      "body": {
        "ok": true
      }
    }
  },
  "created_at": "2026-04-17T00:00:02.000Z",
  "updated_at": "2026-04-17T00:00:03.000Z"
}

Retry an event input parameters

Retry an event accepts the route, header, query, and body inputs listed below.

Retry an event path parameters

idstringRequired

Event ID. Used by the Retry an event operation.

Request

Shell

curl -X POST \
  "https://api.fasthook.io/v1/events/evt_01jv8c4n9p3x7r2t6q5m1k0s8b/retry" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "ok": true,
  "queued": true,
  "transport": "queue",
  "retried_at": "2026-05-10T18:23:41.000Z",
  "event_id": "evt_01jv8c4n9p3x7r2t6q5m1k0s8b",
  "replay_event_id": "evt_01jv8cbn6r2t5x9q4m1k0s7p3b"
}

List event bulk operations input parameters

List event bulk operations accepts the route, header, query, and body inputs listed below.

List event bulk operations query parameters

bucketenumOptional

all | ongoing | history Used by the List event bulk operations operation.

limitintegerOptional

Maximum number of records to return. Used by the List event bulk operations operation.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/events/bulk_operations?bucket=all&limit=100" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "count": 1,
  "models": [
    {
      "id": "bch_01jv8ccp7q3r5t9x2n0k6m1s4b",
      "team_id": "tm_3b5335b627084a838b",
      "type": "event_bulk_retry",
      "status": "running",
      "filter": {
        "from": "2026-04-17T00:00:00.000Z",
        "to": "2026-04-17T23:59:59.999Z",
        "status": "FAILED",
        "source_id": "src_q6z62b6py5o79b",
        "connection_id": "web_nbbweTiOtzsm",
        "destination_id": "des_TU9ioCk5EHUU",
        "q": "timeout"
      },
      "requested_by": null,
      "created_at": "2026-05-10T18:24:00.000Z",
      "started_at": "2026-05-10T18:24:02.000Z",
      "finished_at": null,
      "total_count": 42,
      "queued_count": 42,
      "done_count": 17,
      "failed_count": 0,
      "cancelable": true
    }
  ]
}

Retrieve an event bulk operation input parameters

Retrieve an event bulk operation accepts the route, header, query, and body inputs listed below.

Retrieve an event bulk operation path parameters

idstringRequired

Bulk operation ID. Used by the Retrieve an event bulk operation operation.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/events/bulk_operations/bch_01jv8c9p4q6r2t7x1n0k5m8s3b" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "id": "bch_01jv8c9p4q6r2t7x1n0k5m8s3b",
  "team_id": "tm_3b5335b627084a838b",
  "type": "event_bulk_retry",
  "status": "running",
  "filter": {
    "from": "2026-04-17T00:00:00.000Z",
    "to": "2026-04-17T23:59:59.999Z",
    "status": "FAILED",
    "source_id": "src_q6z62b6py5o79b",
    "connection_id": "web_nbbweTiOtzsm",
    "destination_id": "des_TU9ioCk5EHUU",
    "q": "timeout"
  },
  "requested_by": null,
  "created_at": "2026-05-10T18:24:00.000Z",
  "started_at": "2026-05-10T18:24:02.000Z",
  "finished_at": null,
  "total_count": 42,
  "queued_count": 42,
  "done_count": 17,
  "failed_count": 0,
  "cancelable": true
}

Create event bulk operation input parameters

Create event bulk operation accepts the route, header, query, and body inputs listed below.

Create event bulk operation request body

fromdatetimeOptional

Lower bound on event ingestion time; accepts an ISO datetime or a relative value such as now-1h Used by the Create event bulk operation operation.

todatetimeOptional

Upper bound on event ingestion time; accepts an ISO datetime or a relative value such as now Used by the Create event bulk operation operation.

statusenumOptional

source_idstringOptional

Source ID used to filter inbound requests or routed events. Used by the Create event bulk operation operation.

connection_idstringOptional

Connection ID used to filter routed requests or events. Used by the Create event bulk operation operation.

destination_idstringOptional

Destination ID used to filter outbound events. Used by the Create event bulk operation operation.

qstringOptional

Text search query. Used by the Create event bulk operation operation.

Request

Shell

curl -X POST \
  "https://api.fasthook.io/v1/events/bulk_operations" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID" \
  -H "Content-Type: application/json" \
  --data '{
  "from": "2026-04-17T00:00:00.000Z",
  "to": "2026-04-17T23:59:59.999Z",
  "status": "FAILED",
  "source_id": "src_q6z62b6py5o79b",
  "connection_id": "web_nbbweTiOtzsm",
  "destination_id": "des_TU9ioCk5EHUU",
  "q": "timeout"
}'

Response

JSON

{
  "id": "bch_01jv8ccp7q3r5t9x2n0k6m1s4b",
  "team_id": "tm_3b5335b627084a838b",
  "type": "event_bulk_retry",
  "status": "planned",
  "filter": {
    "from": "2026-04-17T00:00:00.000Z",
    "to": "2026-04-17T23:59:59.999Z",
    "status": "FAILED",
    "source_id": "src_q6z62b6py5o79b",
    "connection_id": "web_nbbweTiOtzsm",
    "destination_id": "des_TU9ioCk5EHUU",
    "q": "timeout"
  },
  "requested_by": null,
  "created_at": "2026-05-10T18:24:00.000Z",
  "started_at": null,
  "finished_at": null,
  "total_count": 42,
  "queued_count": 0,
  "done_count": 0,
  "failed_count": 0,
  "cancelable": true
}

Cancel event bulk operation input parameters

Cancel event bulk operation accepts the route, header, query, and body inputs listed below.

Cancel event bulk operation path parameters

idstringRequired

Bulk operation ID. Used by the Cancel event bulk operation operation.

Request

Shell

curl -X POST \
  "https://api.fasthook.io/v1/events/bulk_operations/bch_01jv8c9p4q6r2t7x1n0k5m8s3b/cancel" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "id": "bch_01jv8ccp7q3r5t9x2n0k6m1s4b",
  "team_id": "tm_3b5335b627084a838b",
  "type": "event_bulk_retry",
  "status": "cancelled",
  "filter": {
    "from": "2026-04-17T00:00:00.000Z",
    "to": "2026-04-17T23:59:59.999Z",
    "status": "FAILED",
    "source_id": "src_q6z62b6py5o79b",
    "connection_id": "web_nbbweTiOtzsm",
    "destination_id": "des_TU9ioCk5EHUU",
    "q": "timeout"
  },
  "requested_by": null,
  "created_at": "2026-05-10T18:24:00.000Z",
  "started_at": "2026-05-10T18:24:02.000Z",
  "finished_at": "2026-05-10T18:26:18.204Z",
  "total_count": 42,
  "queued_count": 42,
  "done_count": 17,
  "failed_count": 0,
  "cancelable": false
}

Attempts

Attempts are individual outbound delivery attempts for events, including response details, retry context, and timing.

Attempts response fields

23 fields

idatt_*

Unique delivery attempt ID. Attempt IDs use the att_ prefix.

team_id

Team that owns the delivery attempt.

event_id

Outbound event this delivery attempt belongs to.

request_id

Inbound request that produced the attempted event, included when the event record is available.

connection_id

Connection that routed the attempted event, included when the event record is available.

source_id

Source that received the original inbound request, included when the event record is available.

destination_id

Destination that received the delivery attempt.

response_status

HTTP response status returned by the destination, or null when unavailable.

attempt_number

Delivery attempt sequence number for the event.

triggerINITIAL | AUTOMATIC | MANUAL | BULK_RETRY | UNPAUSE

Reason the attempt was created, such as initial delivery, automatic retry, manual retry, bulk retry, or unpause.

error_code

Machine-readable failure code when delivery failed.

body

Response body captured from the destination.

requested_url

Final URL FastHook attempted to deliver to.

http_method

HTTP method used for the delivery attempt.

bulk_retry_id

Bulk retry operation that created the attempt, when applicable.

statusSUCCESSFUL | FAILED

Final delivery attempt result.

successful_at

ISO timestamp when the attempt succeeded, or null when failed.

delivered_at

ISO timestamp when FastHook sent the request to the destination.

responded_at

ISO timestamp when FastHook received the destination response.

delivery_latency

Milliseconds spent preparing and sending the delivery.

response_latency

Milliseconds between delivery and destination response.

created_at

ISO timestamp when the attempt record was created.

updated_at

ISO timestamp when the attempt record was last changed.

List attempts input parameters

List attempts accepts the route, header, query, and body inputs listed below.

List attempts query parameters

event_id or event_id[]arrayOptional

Event ID filter. Repeat the parameter to filter by multiple events. Used by the List attempts operation.

request_idstringOptional

Optional exact Request ID filter and shard-routing hint when one event_id is supplied. Used by the List attempts operation.

destination_id or destination_id[]arrayOptional

Destination ID filter. Repeat the parameter to filter by multiple destinations. Used by the List attempts operation.

statusenumOptional

FAILED | SUCCESSFUL Used by the List attempts operation.

fromdatetimeOptional

ISO timestamp or relative time expression such as now-1h. Used by the List attempts operation.

todatetimeOptional

ISO timestamp or relative time expression such as now. Used by the List attempts operation.

qstringOptional

search attempt, event, destination, error code, requested URL, or request ID. Used by the List attempts operation.

order_bystringOptional

Sort field. Currently created_at. Used by the List attempts operation.

direnumOptional

asc | desc, default desc Used by the List attempts operation.

limitintegerOptional

default 100, max 255 Used by the List attempts operation.

nextstringOptional

Opaque cursor from pagination.next. Used by the List attempts operation.

prevstringOptional

Opaque cursor from pagination.prev. Used by the List attempts operation.

List attempts notes

Use either next or prev from pagination for cursor pagination.
Attempts preserve per-delivery response details while events keep aggregate delivery status.

Request

Shell

curl "https://api.fasthook.io/v1/attempts?status=FAILED&from=now-1h&to=now&order_by=created_at&dir=desc&limit=100" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "pagination": {
    "order_by": "created_at",
    "dir": "desc",
    "limit": 100,
    "next": "cur_01jv8cdq6r2t5x9q4m1k0s7p3b",
    "prev": null
  },
  "count": 1,
  "models": [
    {
      "id": "att_01jv8cdq6r2t5x9q4m1k0s7p3b",
      "team_id": "tm_3b5335b627084a838b",
      "event_id": "evt_01jv8c4n9p3x7r2t6q5m1k0s8b",
      "request_id": "req_01jv8c4n8m7p6q5r4s3t2u1v0w",
      "connection_id": "web_01jv8c4n9p3x7r2t6q5m1k0s8b",
      "source_id": "src_01jv8c4n9p3x7r2t6q5m1k0s8b",
      "destination_id": "des_TU9ioCk5EHUU",
      "response_status": 200,
      "attempt_number": 1,
      "trigger": "INITIAL",
      "error_code": null,
      "body": {
        "ok": true
      },
      "requested_url": "https://api.example.com/webhooks",
      "http_method": "POST",
      "bulk_retry_id": null,
      "status": "SUCCESSFUL",
      "successful_at": "2026-04-17T00:00:03.000Z",
      "delivered_at": "2026-04-17T00:00:02.500Z",
      "responded_at": "2026-04-17T00:00:03.000Z",
      "delivery_latency": 12,
      "response_latency": 500,
      "updated_at": "2026-04-17T00:00:03.000Z",
      "created_at": "2026-04-17T00:00:02.000Z"
    }
  ]
}

Retrieve an attempt input parameters

Retrieve an attempt accepts the route, header, query, and body inputs listed below.

Retrieve an attempt path parameters

idstringRequired

Attempt ID. Used by the Retrieve an attempt operation.

Retrieve an attempt query parameters

request_idstringOptional

Optional Request ID routing hint copied from the Attempt model; avoids a cross-shard lookup. Used by the Retrieve an attempt operation.

Retrieve an attempt notes

Returns 404 when the attempt does not exist or is outside the active team.
The request_id hint is optional; omitted or stale hints retain the compatible fallback lookup.

Request

Shell

curl "https://api.fasthook.io/v1/attempts/att_01jv8cdq6r2t5x9q4m1k0s7p3b?request_id=req_01jv8c4n8m7p6q5r4s3t2u1v0w" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "id": "att_01jv8cdq6r2t5x9q4m1k0s7p3b",
  "team_id": "tm_3b5335b627084a838b",
  "event_id": "evt_01jv8c4n9p3x7r2t6q5m1k0s8b",
  "destination_id": "des_TU9ioCk5EHUU",
  "response_status": 500,
  "attempt_number": 2,
  "trigger": "AUTOMATIC",
  "error_code": "http_5xx",
  "body": "upstream unavailable",
  "requested_url": "https://api.example.com/webhooks",
  "http_method": "POST",
  "bulk_retry_id": null,
  "status": "FAILED",
  "successful_at": null,
  "delivered_at": "2026-04-17T00:05:02.500Z",
  "responded_at": "2026-04-17T00:05:03.000Z",
  "delivery_latency": 15,
  "response_latency": 500,
  "updated_at": "2026-04-17T00:05:03.000Z",
  "created_at": "2026-04-17T00:05:02.000Z"
}

Metrics

Metrics endpoints include zero-filled time series for request and event histograms, plus compact 24 hour summaries for source, destination, and transformation list views.

Metrics response fields

43 fields

date_range.start

Start of the returned metrics range.

date_range.end

End of the returned metrics range.

granularity1s | 5s | 10s | 30s | 1m | 5m | 15m | 1h

Time bucket size used for the returned series.

series[].timestamp

Start timestamp for a metrics bucket.

series[].count

Total records counted in the bucket.

series[].accepted_count

Inbound requests accepted in the bucket.

series[].rejected_count

Inbound requests rejected in the bucket.

series[].delivered_count

Outbound events delivered successfully in the bucket.

series[].failed_count

Outbound events failed in the bucket.

series[].queued_count

Outbound events queued in the bucket.

series[].processing_count

Outbound events processing in the bucket.

series[].hold_count

Outbound events held for retry or scheduling in the bucket.

series[].ignored_count

Outbound events ignored in the bucket.

models[].id

models[].id field returned by the Metrics API.

models[].source_id

models[].source_id field returned by the Metrics API.

models[].connection_id

Connection ID for a compact metrics row.

models[].webhook_id

Legacy alias of connection_id.

models[].destination_id

models[].destination_id field returned by the Metrics API.

models[].transformation_id

Transformation ID for a compact metrics row.

models[].requests_24h_count

models[].requests_24h_count field returned by the Metrics API.

models[].requests_24h_total_count

models[].requests_24h_total_count field returned by the Metrics API.

models[].requests_24h_accepted_count

models[].requests_24h_accepted_count field returned by the Metrics API.

models[].requests_24h_rejected_count

models[].requests_24h_rejected_count field returned by the Metrics API.

models[].requests_24h_accepted_bins

models[].requests_24h_accepted_bins field returned by the Metrics API.

models[].requests_24h_rejected_bins

models[].requests_24h_rejected_bins field returned by the Metrics API.

models[].connections_count

Connections that reference the source or transformation in this metrics row.

models[].events_24h_count

Events routed through the connection in the last 24 hours.

models[].events_24h_successful_count

Successful connection events in the last 24 hours.

models[].events_24h_failed_count

Failed connection events in the last 24 hours.

models[].events_24h_pending_count

Scheduled, queued, or held connection events in the last 24 hours.

models[].events_24h_cancelled_count

Cancelled connection events in the last 24 hours.

models[].events_24h_bins

Six buckets, oldest to newest, of all connection events in the last 24 hours.

models[].events_24h_successful_bins

Six buckets of successful connection events.

models[].events_24h_failed_bins

Six buckets of failed connection events.

models[].events_24h_pending_bins

Six buckets of pending connection events.

models[].events_24h_cancelled_bins

Six buckets of cancelled connection events.

models[].attempts_24h_count

models[].attempts_24h_count field returned by the Metrics API.

models[].attempts_24h_bins

models[].attempts_24h_bins field returned by the Metrics API.

models[].executions_24h_count

Transformation executions recorded in the last 24 hours.

models[].executions_24h_successful_count

Transformation executions without error-level logs in the last 24 hours.

models[].executions_24h_failed_count

Transformation executions with error-level logs in the last 24 hours.

models[].executions_24h_successful_bins

Per-model six-bucket history of successful transformation executions during the last 24 hours.

models[].executions_24h_failed_bins

Per-model six-bucket history of failed transformation executions during the last 24 hours.

Request metrics input parameters

Request metrics accepts the route, header, query, and body inputs listed below.

Request metrics query parameters

date_range[start]datetimeRequired

ISO datetime, required Used by the Request metrics operation.

date_range[end]datetimeRequired

ISO datetime, required Used by the Request metrics operation.

granularityenumOptional

1s | 5s | 10s | 30s | 1m | 5m | 15m | 1h Used by the Request metrics operation.

measures[]arrayOptional

count | accepted_count | rejected_count Used by the Request metrics operation.

source_idstringOptional

Source ID used to filter inbound requests or routed events. Used by the Request metrics operation.

batch_operation_idstringOptional

Bulk operation ID used to filter matching requests or events. Used by the Request metrics operation.

statusenumOptional

accepted | rejected Used by the Request metrics operation.

qstringOptional

Text search query. Used by the Request metrics operation.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/metrics/requests?date_range%5Bstart%5D=2026-04-17T00%3A00%3A00.000Z&date_range%5Bend%5D=2026-04-17T23%3A59%3A59.999Z&granularity=1m&measures%5B%5D=count&source_id=src_q6z62b6py5o79b&batch_operation_id=bch_01jv8c9p4q6r2t7x1n0k5m8s3b&status=accepted&q=stripe" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "date_range": {
    "start": "2026-04-17T08:16:00.000Z",
    "end": "2026-04-17T14:16:00.000Z"
  },
  "granularity": "1s",
  "series": [
    {
      "timestamp": "2026-04-17T08:16:00.000Z",
      "count": 12,
      "accepted_count": 11,
      "rejected_count": 1
    }
  ]
}

Event metrics input parameters

Event metrics accepts the route, header, query, and body inputs listed below.

Event metrics query parameters

date_range[start]datetimeRequired

ISO datetime, required Used by the Event metrics operation.

date_range[end]datetimeRequired

ISO datetime, required Used by the Event metrics operation.

granularityenumOptional

1s | 5s | 10s | 30s | 1m | 5m | 15m | 1h Used by the Event metrics operation.

measures[]arrayOptional

source_idstringOptional

Source ID used to filter inbound requests or routed events. Used by the Event metrics operation.

connection_idstringOptional

Connection ID used to filter routed requests or events. Used by the Event metrics operation.

destination_idstringOptional

Destination ID used to filter outbound events. Used by the Event metrics operation.

batch_operation_idstringOptional

Bulk operation ID used to filter matching requests or events. Used by the Event metrics operation.

statusenumOptional

qstringOptional

Text search query. Used by the Event metrics operation.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/metrics/events?date_range%5Bstart%5D=2026-04-17T00%3A00%3A00.000Z&date_range%5Bend%5D=2026-04-17T23%3A59%3A59.999Z&granularity=1m&measures%5B%5D=count&source_id=src_q6z62b6py5o79b&connection_id=web_nbbweTiOtzsm&destination_id=des_TU9ioCk5EHUU&batch_operation_id=bch_01jv8c9p4q6r2t7x1n0k5m8s3b&status=delivered&q=invoice" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "date_range": {
    "start": "2026-04-17T08:16:00.000Z",
    "end": "2026-04-17T14:16:00.000Z"
  },
  "granularity": "1m",
  "series": [
    {
      "timestamp": "2026-04-17T08:16:00.000Z",
      "count": 12,
      "delivered_count": 11,
      "failed_count": 1,
      "queued_count": 0,
      "processing_count": 0,
      "ignored_count": 0
    }
  ]
}

Source summary metrics input parameters

Source summary metrics accepts the route, header, query, and body inputs listed below.

Source summary metrics query parameters

idstringOptional

Source ID. Repeat the parameter or pass comma-separated IDs. Used by the Source summary metrics operation.

idsstringOptional

Plural alias for id; accepts repeated or comma-separated source IDs. Used by the Source summary metrics operation.

source_idstringOptional

Singular source-specific alias for id. Used by the Source summary metrics operation.

source_idsstringOptional

Plural source-specific alias for id. Used by the Source summary metrics operation.

Source summary metrics notes

Use this after GET /v1/sources so the source list response stays lightweight.
Source request bins are ordered oldest to newest across the last 24 hours.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/metrics/sources?id=src_q6z62b6py5o79b&ids=example&source_id=src_q6z62b6py5o79b&source_ids=example" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "count": 1,
  "models": [
    {
      "id": "src_q6z62b6py5o79b",
      "source_id": "src_q6z62b6py5o79b",
      "requests_24h_count": 30,
      "requests_24h_total_count": 32,
      "requests_24h_accepted_count": 30,
      "requests_24h_rejected_count": 2,
      "requests_24h_accepted_bins": [0, 4, 6, 8, 7, 5],
      "requests_24h_rejected_bins": [0, 0, 1, 0, 1, 0],
      "connections_count": 3
    }
  ]
}

Connection summary metrics input parameters

Connection summary metrics accepts the route, header, query, and body inputs listed below.

Connection summary metrics query parameters

idstringOptional

Connection ID. Repeat the parameter or pass comma-separated IDs. Used by the Connection summary metrics operation.

connection_idstringOptional

Alias for id. Used by the Connection summary metrics operation.

webhook_idstringOptional

Legacy alias for id. Used by the Connection summary metrics operation.

Connection summary metrics notes

Use this after GET /v1/connections so the connection list response stays lightweight.
Connection event bins are ordered oldest to newest across the last 24 hours.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/metrics/connections?id=web_nbbweTiOtzsm&connection_id=web_nbbweTiOtzsm&webhook_id=web_nbbweTiOtzsm" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "count": 1,
  "models": [
    {
      "id": "web_nbbweTiOtzsm",
      "connection_id": "web_nbbweTiOtzsm",
      "webhook_id": "web_nbbweTiOtzsm",
      "events_24h_count": 24,
      "events_24h_successful_count": 20,
      "events_24h_failed_count": 2,
      "events_24h_pending_count": 2,
      "events_24h_cancelled_count": 0,
      "events_24h_bins": [0, 3, 6, 5, 4, 6],
      "events_24h_successful_bins": [0, 3, 5, 4, 3, 5],
      "events_24h_failed_bins": [0, 0, 1, 0, 0, 1],
      "events_24h_pending_bins": [0, 0, 0, 1, 1, 0],
      "events_24h_cancelled_bins": [0, 0, 0, 0, 0, 0]
    }
  ]
}

Destination summary metrics input parameters

Destination summary metrics accepts the route, header, query, and body inputs listed below.

Destination summary metrics query parameters

idstringOptional

Destination ID. Repeat the parameter or pass comma-separated IDs. Used by the Destination summary metrics operation.

idsstringOptional

Plural alias for id; accepts repeated or comma-separated destination IDs. Used by the Destination summary metrics operation.

destination_idstringOptional

Singular destination-specific alias for id. Used by the Destination summary metrics operation.

destination_idsstringOptional

Plural destination-specific alias for id. Used by the Destination summary metrics operation.

Destination summary metrics notes

Use this after GET /v1/destinations so the destination list response stays lightweight.
Destination attempt bins are ordered oldest to newest across the last 24 hours.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/metrics/destinations?id=des_TU9ioCk5EHUU&ids=example&destination_id=des_TU9ioCk5EHUU&destination_ids=example" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "count": 1,
  "models": [
    {
      "id": "des_TU9ioCk5EHUU",
      "destination_id": "des_TU9ioCk5EHUU",
      "attempts_24h_count": 12,
      "attempts_24h_bins": [0, 0, 2, 5, 3, 2]
    }
  ]
}

Transformation summary metrics input parameters

Transformation summary metrics accepts the route, header, query, and body inputs listed below.

Transformation summary metrics query parameters

idstringOptional

Transformation ID. Repeat the parameter or pass comma-separated IDs. Used by the Transformation summary metrics operation.

idsstringOptional

Plural alias for id; accepts repeated or comma-separated transformation IDs. Used by the Transformation summary metrics operation.

transformation_idstringOptional

Singular transformation-specific alias for id. Used by the Transformation summary metrics operation.

transformation_idsstringOptional

Plural transformation-specific alias for id. Used by the Transformation summary metrics operation.

Transformation summary metrics notes

Use this after GET /v1/transformations so the transformation list response stays lightweight.
Transformation execution bins are ordered oldest to newest across the last 24 hours.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/metrics/transformations?id=trs_2jYb7sL8mN4pQ9rT&ids=example&transformation_id=example&transformation_ids=example" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "count": 1,
  "models": [
    {
      "id": "trs_2jYb7sL8mN4pQ9rT",
      "transformation_id": "trs_2jYb7sL8mN4pQ9rT",
      "executions_24h_count": 8,
      "executions_24h_successful_count": 7,
      "executions_24h_failed_count": 1,
      "executions_24h_successful_bins": [0, 0, 0, 0, 2, 5],
      "executions_24h_failed_bins": [0, 0, 0, 0, 1, 0],
      "connections_count": 2
    }
  ]
}

Errors

Errors are returned as JSON with a status code and a human-readable message.

Errors response fields

4 fields

error

Short error label returned by the API.

code

Machine-readable error code for programmatic handling.

message

Human-readable explanation of the error.

data

Optional structured details for conflict or validation errors.

Error format input parameters

Error format accepts the route, header, query, and body inputs listed below.

Error format path parameters

idstringRequired

Source ID. Used by the Error format operation.

Error format notes

401 means authentication is missing or invalid.
403 means the authenticated principal cannot access the team.
404 means the resource or route was not found.
409 is used for duplicate resources or retry conflicts.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/sources/src_q6z62b6py5o79b" \
  -H "Authorization: Bearer $API_KEY" \
  -H "x-team-id: $TEAM_ID"

Response

JSON

{
  "error": "Unauthorized",
  "code": "unauthorized",
  "message": "Authorization: Bearer token or x-api-key is required"
}