API Reference

Event Gateway API Reference

Complete REST API reference for building webhook infrastructure with FastHook: create webhook sources, configure HTTP destinations, connect routing rules, inspect inbound requests, retry failed delivery events, run bulk replay operations, transform payloads, query metrics, and manage authentication or project secrets.

Use these endpoints to automate event gateway workflows, debug webhook delivery, count requests and events by time range, and operate replay-safe webhook 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.

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

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.

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

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.

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.

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Request body

id_token or credentialstringRequired

required Google ID token

team_idstringOptional

optional team ID used to scope the session

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
  }
}

Input parameters

This endpoint does not require path, query, or body parameters.

Request

Shell

curl -X POST \
  "https://api.fasthook.io/v1/auth/demo/login"

Response

JSON

{
  "ok": true,
  "demo": true,
  "token": "fhsess_demo_20260510_billing_workspace_8x3p6q2m",
  "team_id": "tm_demo_flow_001",
  "expires_at": "2026-05-10T18:00:00.000Z",
  "user": {
    "id": "usr_demo_flow_001",
    "email": "demo@fasthook.io",
    "name": "Demo User",
    "picture_url": null
  },
  "demo_seed": {
    "requested": 5,
    "queued": 5,
    "source_id": "src_q6z62b6py5o79b",
    "source_state": "enabled"
  }
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

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"
    }
  ]
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Request body

nameintegerRequired

required string, max 120 characters

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"
    }
  ]
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Sources

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

Response fields

15 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.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.

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Query parameters

idstringOptional

optional ID filter, comma-separated or repeated

namestringOptional

optional exact name filter

typestringOptional

optional resource type filter

disabledstringOptional

false excludes disabled resources

order_byenumOptional

name | created_at | updated_at

direnumOptional

asc | desc

limitintegerOptional

max 255

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
    }
  ]
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Source ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

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
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Request body

namestringRequired

required string

descriptionstringOptional

optional string or null

typestringOptional

optional string, 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.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_msstringOptional

optional 1000-30000 upstream timeout in milliseconds

config.proxy.response_capture_limit_bytesstringOptional

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

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"
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Request body

namestringRequired

required string

descriptionstringOptional

optional string or null

typestringOptional

optional string, 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.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_msstringOptional

optional 1000-30000 upstream timeout in milliseconds

config.proxy.response_capture_limit_bytesstringOptional

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

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"
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Source ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Request body

namestringOptional

optional string

descriptionstringOptional

optional string or null

typestringOptional

optional string

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.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_msstringOptional

optional 1000-30000 upstream timeout in milliseconds

config.proxy.response_capture_limit_bytesstringOptional

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

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"
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Source ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

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"
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Source ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

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"
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Source ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

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.

Response fields

24 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, MOCK_API, GOOGLE_SHEET, GMAIL, SENDGRID_EMAIL, SLACK, DISCORD_WEBHOOK, TELEGRAM_MESSAGE, CLOUDFLARE_R2, AWS_S3, TWILIO_WHATSAPP, TWILIO_SMS, or TWILIO_MMS.

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

HTTP delivery URL, CLI/mock path, sheet-specific Google Sheet settings, Gmail email settings, SendGrid email settings, Slack channel settings, Discord webhook settings, Telegram message settings, Cloudflare R2 archive settings, AWS S3 archive settings, Twilio WhatsApp settings, Twilio SMS settings, or Twilio MMS 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, SENDGRID_API_KEY, SLACK_BOT_TOKEN, R2_ACCESS_KEY, AWS_ACCESS_KEY, TWILIO_AUTH_TOKEN, or Google Sheet service account auth.

config.auth

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

config.spreadsheet_id

Google Sheet spreadsheet ID for GOOGLE_SHEET destinations.

config.sheet_name

Google Sheet tab name; defaults to Sheet1.

config.value_input_option

Google Sheets value input mode: RAW or USER_ENTERED.

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 GOOGLE_SHEET, 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.

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Query parameters

idstringOptional

optional ID filter, comma-separated or repeated

namestringOptional

optional exact name filter

typestringOptional

optional resource type filter

disabledstringOptional

false excludes disabled resources

order_byenumOptional

name | created_at | updated_at

direnumOptional

asc | desc

limitintegerOptional

max 255

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]
    }
  ]
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Destination ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

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]
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Request body

namestringRequired

required string

descriptionstringOptional

optional string or null

typeenumOptional

config.url, config.path, Google Sheet config, Gmail config, SendGrid Email config, Slack config, Discord Webhook config, Telegram Message config, Cloudflare R2 config, AWS S3 config, Twilio WhatsApp config, Twilio SMS config, or Twilio MMS config

stringRequired

required destination target

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_typeintegerOptional

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.spreadsheet_idstringRequired

required for GOOGLE_SHEET

config.sheet_namestringOptional

optional for GOOGLE_SHEET, defaults to Sheet1

config.value_input_optionenumOptional

RAW | USER_ENTERED

config.columnsarrayOptional

optional array of dotted payload or metadata paths

config.include_metadatabooleanOptional

optional boolean

config.toarrayRequired

required for GMAIL; string or array of recipient templates

config.cc/config.bcc/config.reply_tostringOptional

optional for GMAIL

config.subjectstringOptional

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

config.text_template/config.html_templatestringOptional

optional for GMAIL

config.auth_typestringOptional

GOOGLE_OAUTH_REFRESH_TOKEN for GMAIL

config.auth.client_id/client_secret/refresh_tokenstringRequired

required for GMAIL

config.auth.scopestringOptional

https://www.googleapis.com/auth/gmail.send for GMAIL

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.channelstringRequired

required for SLACK; channel name or channel ID, with IDs preferred for private or renamed channels

config.text_templatestringRequired

required message text template for SLACK; also used as Slack fallback text when blocks are present

config.blocks_templatearrayOptional

optional JSON string for Slack Block Kit blocks; rendered template must become an array or an object with a blocks array

config.auth_typestringOptional

SLACK_BOT_TOKEN for SLACK

config.auth.bot_tokenstringRequired

required xoxb- Slack bot token for SLACK

Slack bot token needs chatstringOptional

write; add chat:write.public only when posting to public channels without inviting the app first

Invite the Slack app bot to private channels and to public channels when chatstringOptional

write.public is not used

config.webhook_urlstringRequired

required for DISCORD_WEBHOOK; Discord execute webhook URL

config.content_templatestringOptional

optional message content template for DISCORD_WEBHOOK, defaults to FastHook event {{event_id}} and {{payload}}

config.username_template/config.avatar_url_templatestringOptional

optional webhook sender overrides

config.embeds_templatearrayOptional

optional JSON object or array of Discord embeds after template rendering

config.allowed_mentions_parsearrayOptional

optional array containing roles, users, and/or everyone; defaults to empty to avoid pings

DISCORD_WEBHOOK destinations are fixed at 1 request per secondstringOptional

Request parameter.

config.account_idintegerRequired

required for CLOUDFLARE_R2; client Cloudflare account ID

config.endpointintegerOptional

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

config.tostringRequired

required for TWILIO_WHATSAPP; WhatsApp recipient address or template, usually whatsapp:+E.164

config.fromstringRequired

required for TWILIO_WHATSAPP unless config.messaging_service_sid is set; Sandbox sender is whatsapp:+14155238886

config.body_templatestringRequired

required message body template for TWILIO_WHATSAPP free-form sends

config.messaging_service_sidstringRequired

optional MG... SID; required when config.content_sid is set and common for production sender pools

config.content_sidstringOptional

optional HX... Twilio Content SID for approved WhatsApp templates

config.content_variables_templateobjectOptional

optional JSON object string for Twilio ContentVariables, for example {"1":"{{payload.customer.name}}"}

config.auth_typestringOptional

TWILIO_AUTH_TOKEN for TWILIO_WHATSAPP

config.auth.account_sid/config.auth.auth_tokenintegerRequired

required for TWILIO_WHATSAPP

Sandbox recipients must send join <code> to +14155238886 from the exact WhatsApp account that should receive messagesintegerOptional

Request parameter.

From and To must be different WhatsApp addresses; Twilio error 63031 means they are the samestringOptional

Request parameter.

Twilio error 63015 usually means the Sandbox recipient has not joined the current SandboxstringOptional

Request parameter.

config.tostringRequired

required for TWILIO_SMS; SMS recipient phone number or template, usually +E.164

config.fromstringRequired

required for TWILIO_SMS unless config.messaging_service_sid is set; SMS-capable Twilio number, short code, or alphanumeric sender ID

config.body_templatestringRequired

required message body template for TWILIO_SMS; supports {{payload.message}} and shorthand {{message}}

config.messaging_service_sidstringOptional

optional MG... SID for Twilio Messaging Service sender pools

config.auth_typestringOptional

TWILIO_AUTH_TOKEN for TWILIO_SMS

config.auth.account_sid/config.auth.auth_tokenintegerRequired

required for TWILIO_SMS

Trial accounts can usually send SMS only to verified recipient numbers; Twilio error 21608 means the To number needs verification

integerOptional

Request parameter.

Enable Twilio SMS Geo Permissions for the destination country; Twilio error 21408 means that country is not enabledintegerOptional

Request parameter.

Twilio error 21606 usually means the From sender is not SMS-capable for that recipientstringOptional

Request parameter.

config.tostringRequired

required for TWILIO_MMS; MMS recipient phone number or template, usually +E.164

config.fromstringRequired

required for TWILIO_MMS unless config.messaging_service_sid is set; MMS-capable Twilio number

config.body_templatestringRequired

required message body template for TWILIO_MMS; supports {{payload.message}} and shorthand {{message}}

config.media_urlsarrayRequired

required array of one to ten public HTTP or HTTPS media URLs; template tokens such as {{payload.media_url}} and {{media_url}} are supported

config.messaging_service_sidstringOptional

optional MG... SID for Twilio Messaging Service sender pools

config.auth_typestringOptional

TWILIO_AUTH_TOKEN for TWILIO_MMS

config.auth.account_sid/config.auth.auth_tokenintegerRequired

required for TWILIO_MMS

Trial accounts can usually send only to verified recipient numbers; Twilio error 21608 means the To number needs verification

integerOptional

Request parameter.

Enable Twilio Messaging Geo Permissions for the destination country; Twilio error 21408 means that country is not enabled

integerOptional

Request parameter.

The sender, Messaging Service, country, and carrier route must support MMS; SMS support alone does not guarantee MMS delivery

integerOptional

Request parameter.

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]
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Request body

namestringRequired

required string

descriptionstringOptional

optional string or null

typeenumOptional

config.url, config.path, Google Sheet config, Gmail config, SendGrid Email config, Slack config, Discord Webhook config, Telegram Message config, Cloudflare R2 config, AWS S3 config, Twilio WhatsApp config, Twilio SMS config, or Twilio MMS config

stringRequired

required destination target

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_typeintegerOptional

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.spreadsheet_idstringRequired

required for GOOGLE_SHEET

config.sheet_namestringOptional

optional for GOOGLE_SHEET, defaults to Sheet1

config.value_input_optionenumOptional

RAW | USER_ENTERED

config.columnsarrayOptional

optional array of dotted payload or metadata paths

config.include_metadatabooleanOptional

optional boolean

config.toarrayRequired

required for GMAIL; string or array of recipient templates

config.cc/config.bcc/config.reply_tostringOptional

optional for GMAIL

config.subjectstringOptional

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

config.text_template/config.html_templatestringOptional

optional for GMAIL

config.auth_typestringOptional

GOOGLE_OAUTH_REFRESH_TOKEN for GMAIL

config.auth.client_id/client_secret/refresh_tokenstringRequired

required for GMAIL

config.auth.scopestringOptional

https://www.googleapis.com/auth/gmail.send for GMAIL

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.channelstringRequired

required for SLACK; channel name or channel ID, with IDs preferred for private or renamed channels

config.text_templatestringRequired

required message text template for SLACK; also used as Slack fallback text when blocks are present

config.blocks_templatearrayOptional

optional JSON string for Slack Block Kit blocks; rendered template must become an array or an object with a blocks array

config.auth_typestringOptional

SLACK_BOT_TOKEN for SLACK

config.auth.bot_tokenstringRequired

required xoxb- Slack bot token for SLACK

Slack bot token needs chatstringOptional

write; add chat:write.public only when posting to public channels without inviting the app first

Invite the Slack app bot to private channels and to public channels when chatstringOptional

write.public is not used

config.webhook_urlstringRequired

required for DISCORD_WEBHOOK; Discord execute webhook URL

config.content_templatestringOptional

optional message content template for DISCORD_WEBHOOK, defaults to FastHook event {{event_id}} and {{payload}}

config.username_template/config.avatar_url_templatestringOptional

optional webhook sender overrides

config.embeds_templatearrayOptional

optional JSON object or array of Discord embeds after template rendering

config.allowed_mentions_parsearrayOptional

optional array containing roles, users, and/or everyone; defaults to empty to avoid pings

DISCORD_WEBHOOK destinations are fixed at 1 request per secondstringOptional

Request parameter.

config.account_idintegerRequired

required for CLOUDFLARE_R2; client Cloudflare account ID

config.endpointintegerOptional

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

config.tostringRequired

required for TWILIO_WHATSAPP; WhatsApp recipient address or template, usually whatsapp:+E.164

config.fromstringRequired

required for TWILIO_WHATSAPP unless config.messaging_service_sid is set; Sandbox sender is whatsapp:+14155238886

config.body_templatestringRequired

required message body template for TWILIO_WHATSAPP free-form sends

config.messaging_service_sidstringRequired

optional MG... SID; required when config.content_sid is set and common for production sender pools

config.content_sidstringOptional

optional HX... Twilio Content SID for approved WhatsApp templates

config.content_variables_templateobjectOptional

optional JSON object string for Twilio ContentVariables, for example {"1":"{{payload.customer.name}}"}

config.auth_typestringOptional

TWILIO_AUTH_TOKEN for TWILIO_WHATSAPP

config.auth.account_sid/config.auth.auth_tokenintegerRequired

required for TWILIO_WHATSAPP

Sandbox recipients must send join <code> to +14155238886 from the exact WhatsApp account that should receive messagesintegerOptional

Request parameter.

From and To must be different WhatsApp addresses; Twilio error 63031 means they are the samestringOptional

Request parameter.

Twilio error 63015 usually means the Sandbox recipient has not joined the current SandboxstringOptional

Request parameter.

config.tostringRequired

required for TWILIO_SMS; SMS recipient phone number or template, usually +E.164

config.fromstringRequired

required for TWILIO_SMS unless config.messaging_service_sid is set; SMS-capable Twilio number, short code, or alphanumeric sender ID

config.body_templatestringRequired

required message body template for TWILIO_SMS; supports {{payload.message}} and shorthand {{message}}

config.messaging_service_sidstringOptional

optional MG... SID for Twilio Messaging Service sender pools

config.auth_typestringOptional

TWILIO_AUTH_TOKEN for TWILIO_SMS

config.auth.account_sid/config.auth.auth_tokenintegerRequired

required for TWILIO_SMS

Trial accounts can usually send SMS only to verified recipient numbers; Twilio error 21608 means the To number needs verification

integerOptional

Request parameter.

Enable Twilio SMS Geo Permissions for the destination country; Twilio error 21408 means that country is not enabledintegerOptional

Request parameter.

Twilio error 21606 usually means the From sender is not SMS-capable for that recipientstringOptional

Request parameter.

config.tostringRequired

required for TWILIO_MMS; MMS recipient phone number or template, usually +E.164

config.fromstringRequired

required for TWILIO_MMS unless config.messaging_service_sid is set; MMS-capable Twilio number

config.body_templatestringRequired

required message body template for TWILIO_MMS; supports {{payload.message}} and shorthand {{message}}

config.media_urlsarrayRequired

required array of one to ten public HTTP or HTTPS media URLs; template tokens such as {{payload.media_url}} and {{media_url}} are supported

config.messaging_service_sidstringOptional

optional MG... SID for Twilio Messaging Service sender pools

config.auth_typestringOptional

TWILIO_AUTH_TOKEN for TWILIO_MMS

config.auth.account_sid/config.auth.auth_tokenintegerRequired

required for TWILIO_MMS

Trial accounts can usually send only to verified recipient numbers; Twilio error 21608 means the To number needs verification

integerOptional

Request parameter.

Enable Twilio Messaging Geo Permissions for the destination country; Twilio error 21408 means that country is not enabled

integerOptional

Request parameter.

The sender, Messaging Service, country, and carrier route must support MMS; SMS support alone does not guarantee MMS delivery

integerOptional

Request parameter.

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]
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Destination ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Request body

namestringRequired

required string

descriptionstringOptional

optional string or null

typeenumOptional

config.url, config.path, Google Sheet config, Gmail config, SendGrid Email config, Slack config, Discord Webhook config, Telegram Message config, Cloudflare R2 config, AWS S3 config, Twilio WhatsApp config, Twilio SMS config, or Twilio MMS config

stringRequired

required destination target

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_typeintegerOptional

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.spreadsheet_idstringRequired

required for GOOGLE_SHEET

config.sheet_namestringOptional

optional for GOOGLE_SHEET, defaults to Sheet1

config.value_input_optionenumOptional

RAW | USER_ENTERED

config.columnsarrayOptional

optional array of dotted payload or metadata paths

config.include_metadatabooleanOptional

optional boolean

config.toarrayRequired

required for GMAIL; string or array of recipient templates

config.cc/config.bcc/config.reply_tostringOptional

optional for GMAIL

config.subjectstringOptional

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

config.text_template/config.html_templatestringOptional

optional for GMAIL

config.auth_typestringOptional

GOOGLE_OAUTH_REFRESH_TOKEN for GMAIL

config.auth.client_id/client_secret/refresh_tokenstringRequired

required for GMAIL

config.auth.scopestringOptional

https://www.googleapis.com/auth/gmail.send for GMAIL

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.channelstringRequired

required for SLACK; channel name or channel ID, with IDs preferred for private or renamed channels

config.text_templatestringRequired

required message text template for SLACK; also used as Slack fallback text when blocks are present

config.blocks_templatearrayOptional

optional JSON string for Slack Block Kit blocks; rendered template must become an array or an object with a blocks array

config.auth_typestringOptional

SLACK_BOT_TOKEN for SLACK

config.auth.bot_tokenstringRequired

required xoxb- Slack bot token for SLACK

Slack bot token needs chatstringOptional

write; add chat:write.public only when posting to public channels without inviting the app first

Invite the Slack app bot to private channels and to public channels when chatstringOptional

write.public is not used

config.webhook_urlstringRequired

required for DISCORD_WEBHOOK; Discord execute webhook URL

config.content_templatestringOptional

optional message content template for DISCORD_WEBHOOK, defaults to FastHook event {{event_id}} and {{payload}}

config.username_template/config.avatar_url_templatestringOptional

optional webhook sender overrides

config.embeds_templatearrayOptional

optional JSON object or array of Discord embeds after template rendering

config.allowed_mentions_parsearrayOptional

optional array containing roles, users, and/or everyone; defaults to empty to avoid pings

DISCORD_WEBHOOK destinations are fixed at 1 request per secondstringOptional

Request parameter.

config.account_idintegerRequired

required for CLOUDFLARE_R2; client Cloudflare account ID

config.endpointintegerOptional

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

config.tostringRequired

required for TWILIO_WHATSAPP; WhatsApp recipient address or template, usually whatsapp:+E.164

config.fromstringRequired

required for TWILIO_WHATSAPP unless config.messaging_service_sid is set; Sandbox sender is whatsapp:+14155238886

config.body_templatestringRequired

required message body template for TWILIO_WHATSAPP free-form sends

config.messaging_service_sidstringRequired

optional MG... SID; required when config.content_sid is set and common for production sender pools

config.content_sidstringOptional

optional HX... Twilio Content SID for approved WhatsApp templates

config.content_variables_templateobjectOptional

optional JSON object string for Twilio ContentVariables, for example {"1":"{{payload.customer.name}}"}

config.auth_typestringOptional

TWILIO_AUTH_TOKEN for TWILIO_WHATSAPP

config.auth.account_sid/config.auth.auth_tokenintegerRequired

required for TWILIO_WHATSAPP

Sandbox recipients must send join <code> to +14155238886 from the exact WhatsApp account that should receive messagesintegerOptional

Request parameter.

From and To must be different WhatsApp addresses; Twilio error 63031 means they are the samestringOptional

Request parameter.

Twilio error 63015 usually means the Sandbox recipient has not joined the current SandboxstringOptional

Request parameter.

config.tostringRequired

required for TWILIO_SMS; SMS recipient phone number or template, usually +E.164

config.fromstringRequired

required for TWILIO_SMS unless config.messaging_service_sid is set; SMS-capable Twilio number, short code, or alphanumeric sender ID

config.body_templatestringRequired

required message body template for TWILIO_SMS; supports {{payload.message}} and shorthand {{message}}

config.messaging_service_sidstringOptional

optional MG... SID for Twilio Messaging Service sender pools

config.auth_typestringOptional

TWILIO_AUTH_TOKEN for TWILIO_SMS

config.auth.account_sid/config.auth.auth_tokenintegerRequired

required for TWILIO_SMS

Trial accounts can usually send SMS only to verified recipient numbers; Twilio error 21608 means the To number needs verification

integerOptional

Request parameter.

Enable Twilio SMS Geo Permissions for the destination country; Twilio error 21408 means that country is not enabledintegerOptional

Request parameter.

Twilio error 21606 usually means the From sender is not SMS-capable for that recipientstringOptional

Request parameter.

config.tostringRequired

required for TWILIO_MMS; MMS recipient phone number or template, usually +E.164

config.fromstringRequired

required for TWILIO_MMS unless config.messaging_service_sid is set; MMS-capable Twilio number

config.body_templatestringRequired

required message body template for TWILIO_MMS; supports {{payload.message}} and shorthand {{message}}

config.media_urlsarrayRequired

required array of one to ten public HTTP or HTTPS media URLs; template tokens such as {{payload.media_url}} and {{media_url}} are supported

config.messaging_service_sidstringOptional

optional MG... SID for Twilio Messaging Service sender pools

config.auth_typestringOptional

TWILIO_AUTH_TOKEN for TWILIO_MMS

config.auth.account_sid/config.auth.auth_tokenintegerRequired

required for TWILIO_MMS

Trial accounts can usually send only to verified recipient numbers; Twilio error 21608 means the To number needs verification

integerOptional

Request parameter.

Enable Twilio Messaging Geo Permissions for the destination country; Twilio error 21408 means that country is not enabled

integerOptional

Request parameter.

The sender, Messaging Service, country, and carrier route must support MMS; SMS support alone does not guarantee MMS delivery

integerOptional

Request parameter.

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]
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Destination ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Request body

namestringOptional

optional string

descriptionstringOptional

optional string or null

typeenumOptional

config.url, config.path, Google Sheet config, Gmail config, SendGrid Email config, Slack config, Discord Webhook config, Telegram Message config, Cloudflare R2 config, AWS S3 config, Twilio WhatsApp config, Twilio SMS config, or Twilio MMS config

stringOptional

optional destination target

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_typeintegerOptional

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.spreadsheet_idstringRequired

required for GOOGLE_SHEET

config.sheet_namestringOptional

optional for GOOGLE_SHEET, defaults to Sheet1

config.value_input_optionenumOptional

RAW | USER_ENTERED

config.columnsarrayOptional

optional array of dotted payload or metadata paths

config.include_metadatabooleanOptional

optional boolean

config.toarrayRequired

required for GMAIL; string or array of recipient templates

config.cc/config.bcc/config.reply_tostringOptional

optional for GMAIL

config.subjectstringOptional

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

config.text_template/config.html_templatestringOptional

optional for GMAIL

config.auth_typestringOptional

GOOGLE_OAUTH_REFRESH_TOKEN for GMAIL

config.auth.client_id/client_secret/refresh_tokenstringRequired

required for GMAIL

config.auth.scopestringOptional

https://www.googleapis.com/auth/gmail.send for GMAIL

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.channelstringRequired

required for SLACK; channel name or channel ID, with IDs preferred for private or renamed channels

config.text_templatestringRequired

required message text template for SLACK; also used as Slack fallback text when blocks are present

config.blocks_templatearrayOptional

optional JSON string for Slack Block Kit blocks; rendered template must become an array or an object with a blocks array

config.auth_typestringOptional

SLACK_BOT_TOKEN for SLACK

config.auth.bot_tokenstringRequired

required xoxb- Slack bot token for SLACK

Slack bot token needs chatstringOptional

write; add chat:write.public only when posting to public channels without inviting the app first

Invite the Slack app bot to private channels and to public channels when chatstringOptional

write.public is not used

config.webhook_urlstringRequired

required for DISCORD_WEBHOOK; Discord execute webhook URL

config.content_templatestringOptional

optional message content template for DISCORD_WEBHOOK, defaults to FastHook event {{event_id}} and {{payload}}

config.username_template/config.avatar_url_templatestringOptional

optional webhook sender overrides

config.embeds_templatearrayOptional

optional JSON object or array of Discord embeds after template rendering

config.allowed_mentions_parsearrayOptional

optional array containing roles, users, and/or everyone; defaults to empty to avoid pings

DISCORD_WEBHOOK destinations are fixed at 1 request per secondstringOptional

Request parameter.

config.account_idintegerRequired

required for CLOUDFLARE_R2; client Cloudflare account ID

config.endpointintegerOptional

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

config.tostringRequired

required for TWILIO_WHATSAPP; WhatsApp recipient address or template, usually whatsapp:+E.164

config.fromstringRequired

required for TWILIO_WHATSAPP unless config.messaging_service_sid is set; Sandbox sender is whatsapp:+14155238886

config.body_templatestringRequired

required message body template for TWILIO_WHATSAPP free-form sends

config.messaging_service_sidstringRequired

optional MG... SID; required when config.content_sid is set and common for production sender pools

config.content_sidstringOptional

optional HX... Twilio Content SID for approved WhatsApp templates

config.content_variables_templateobjectOptional

optional JSON object string for Twilio ContentVariables, for example {"1":"{{payload.customer.name}}"}

config.auth_typestringOptional

TWILIO_AUTH_TOKEN for TWILIO_WHATSAPP

config.auth.account_sid/config.auth.auth_tokenintegerRequired

required for TWILIO_WHATSAPP

Sandbox recipients must send join <code> to +14155238886 from the exact WhatsApp account that should receive messagesintegerOptional

Request parameter.

From and To must be different WhatsApp addresses; Twilio error 63031 means they are the samestringOptional

Request parameter.

Twilio error 63015 usually means the Sandbox recipient has not joined the current SandboxstringOptional

Request parameter.

config.tostringRequired

required for TWILIO_SMS; SMS recipient phone number or template, usually +E.164

config.fromstringRequired

required for TWILIO_SMS unless config.messaging_service_sid is set; SMS-capable Twilio number, short code, or alphanumeric sender ID

config.body_templatestringRequired

required message body template for TWILIO_SMS; supports {{payload.message}} and shorthand {{message}}

config.messaging_service_sidstringOptional

optional MG... SID for Twilio Messaging Service sender pools

config.auth_typestringOptional

TWILIO_AUTH_TOKEN for TWILIO_SMS

config.auth.account_sid/config.auth.auth_tokenintegerRequired

required for TWILIO_SMS

Trial accounts can usually send SMS only to verified recipient numbers; Twilio error 21608 means the To number needs verification

integerOptional

Request parameter.

Enable Twilio SMS Geo Permissions for the destination country; Twilio error 21408 means that country is not enabledintegerOptional

Request parameter.

Twilio error 21606 usually means the From sender is not SMS-capable for that recipientstringOptional

Request parameter.

config.tostringRequired

required for TWILIO_MMS; MMS recipient phone number or template, usually +E.164

config.fromstringRequired

required for TWILIO_MMS unless config.messaging_service_sid is set; MMS-capable Twilio number

config.body_templatestringRequired

required message body template for TWILIO_MMS; supports {{payload.message}} and shorthand {{message}}

config.media_urlsarrayRequired

required array of one to ten public HTTP or HTTPS media URLs; template tokens such as {{payload.media_url}} and {{media_url}} are supported

config.messaging_service_sidstringOptional

optional MG... SID for Twilio Messaging Service sender pools

config.auth_typestringOptional

TWILIO_AUTH_TOKEN for TWILIO_MMS

config.auth.account_sid/config.auth.auth_tokenintegerRequired

required for TWILIO_MMS

Trial accounts can usually send only to verified recipient numbers; Twilio error 21608 means the To number needs verification

integerOptional

Request parameter.

Enable Twilio Messaging Geo Permissions for the destination country; Twilio error 21408 means that country is not enabled

integerOptional

Request parameter.

The sender, Messaging Service, country, and carrier route must support MMS; SMS support alone does not guarantee MMS delivery

integerOptional

Request parameter.

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]
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Destination ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

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]
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Destination ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

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]
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Destination ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

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.

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

Six buckets, oldest to newest, of successful transformation executions over the last 24 hours.

executions_24h_failed_bins

Six buckets, oldest to newest, of failed transformation executions over 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.

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Query parameters

idstringOptional

optional ID filter, comma-separated or repeated

namestringOptional

optional exact name filter

include_metricsintegerOptional

true includes legacy execution and connection counts

order_byenumOptional

name | created_at | updated_at

direnumOptional

asc | desc

limitintegerOptional

max 255

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
    }
  ]
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Request body

namestringRequired

required

codestringRequired

required

envobjectOptional

optional object

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
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Request body

namestringRequired

required string

codestringRequired

required string

envobjectOptional

optional object

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
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Request body

transformation_idstringOptional

optional saved transformation ID

codestringOptional

optional JavaScript code when transformation_id is omitted

envobjectOptional

optional object of string variables

request.headersobjectOptional

optional object

request.bodystringOptional

optional JSON value

request.queryobjectOptional

optional object or query string

request.pathstringOptional

optional path string

request.methodstringOptional

optional HTTP method

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
  }
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Transformation ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

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
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Transformation ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Request body

namestringOptional

optional string

codestringOptional

optional string

envobjectOptional

optional object

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
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Transformation ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

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"
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Transformation ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

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"
        }
      ]
    }
  ]
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Transformation ID.

executionIdstringRequired

Transformation execution ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

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"
  }
}

Connections

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

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.

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Query parameters

order_byenumOptional

name | created_at | updated_at

direnumOptional

asc | desc

limitintegerOptional

max 255

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
    }
  ]
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Connection ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

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
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Request body

namestringRequired

required string

descriptionstringOptional

optional string or null

source_id or source.idstringRequired

required source ID

destination_id or destination.idstringRequired

required destination ID

disabled_atdatetimeOptional

optional ISO datetime or null

paused_atdatetimeOptional

optional ISO datetime or null

rulesarrayOptional

optional array of retry, delay, filter, transform, and deduplicate rules

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"
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Request body

idstringOptional

optional connection ID to upsert directly

namestringRequired

required string when id is omitted

descriptionstringOptional

optional string or null

source_id or source.idstringRequired

required source ID

destination_id or destination.idstringRequired

required destination ID

disabled_atdatetimeOptional

optional ISO datetime or null

paused_atdatetimeOptional

optional ISO datetime or null

rulesarrayOptional

optional array of retry, delay, filter, transform, and deduplicate rules

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"
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Connection ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Request body

namestringOptional

optional string

descriptionstringOptional

optional string or null

source_id or source.idstringOptional

optional source ID

destination_id or destination.idstringOptional

optional destination ID

disabled_atdatetimeOptional

optional ISO datetime or null

paused_atdatetimeOptional

optional ISO datetime or null

rulesarrayOptional

optional array of retry, delay, filter, transform, and deduplicate rules

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"
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Connection ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

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"
    }
  }
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Connection ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

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"
  }
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Connection ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

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"
  }
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Connection ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

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"
  }
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Connection ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

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"
  }
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Connection ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

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.

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.

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Connection ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Request body

rulesarrayOptional

Request parameter.

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 Secrets

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

Response fields

9 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

Project API key used to authenticate Control API requests.

api_key.masked_value

Redacted API key display value.

api_key.last_rotated_at

ISO timestamp when the API key was last rotated.

signing_secret.value

Secret used to sign FastHook outbound webhook deliveries.

signing_secret.masked_value

Redacted signing secret display value.

signing_secret.last_rotated_at

ISO timestamp when the signing secret was last rotated.

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

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": {
    "value": "fhp_live_01jv8c5q9m2p7x4r6t8n3k0b1s",
    "masked_value": "fhp************04ad",
    "last_rotated_at": "2026-01-14T13:36:41.701Z"
  },
  "signing_secret": {
    "value": "fhsig_live_01jv8c5w4b9n6q2p8r7t1m3x0k",
    "masked_value": "fhs************38fb",
    "last_rotated_at": "2026-01-14T13:36:41.702Z"
  }
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Request body

api_keystringOptional

optional string, min 12

signing_secretstringOptional

optional string, min 12

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": {
    "value": "fhp_custom_secret",
    "masked_value": "fhp************cret",
    "last_rotated_at": "2026-05-10T18:15:00.000Z"
  },
  "signing_secret": {
    "value": "fhsig_custom_secret",
    "masked_value": "fhs************cret",
    "last_rotated_at": "2026-05-10T18:15:00.000Z"
  }
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Request body

rotatearrayOptional

optional array of api_key and signing_secret

Notes

Empty body rotates both secrets.
Use rotate=["signing_secret"] to rotate only the signing secret.

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",
    "last_rotated_at": "2026-05-10T18:16:22.504Z"
  },
  "signing_secret": {
    "value": "fhsig_live_01jv8c6z7p2x9r4t1n0k8s5m",
    "masked_value": "fhs************42ce",
    "last_rotated_at": "2026-05-10T18:16:22.504Z"
  }
}

Requests

Requests are inbound webhook deliveries received by FastHook.

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.

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Query parameters

fromdatetimeOptional

ISO datetime or relative time

todatetimeOptional

ISO datetime or relative time

limitintegerOptional

default 100, max 100

cursorstringOptional

opaque next_cursor or next value

statusenumOptional

accepted | rejected

verifiedbooleanOptional

true | false

source_idstringOptional

Source ID used to filter inbound requests or routed events.

connection_idstringOptional

Connection ID used to filter routed requests or events.

batch_operation_idstringOptional

Bulk operation ID used to filter matching requests or events.

is_retrybooleanOptional

true | false

retry_kindenumOptional

single | bulk

q or search_termstringOptional

search across id and external_id

includestringOptional

data, optional stored payload data

Notes

When next_cursor is null, total is exact and total_exact is true.
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"
    }
  ]
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Query parameters

from or ingested_at[gte]datetimeOptional

ISO datetime or relative time

to or ingested_at[lte]datetimeOptional

ISO datetime or relative time

statusenumOptional

accepted | rejected

verifiedbooleanOptional

true | false

source_idstringOptional

Source ID used to filter inbound requests or routed events.

connection_idstringOptional

Connection ID used to filter routed requests or events.

batch_operation_idstringOptional

Bulk operation ID used to filter matching requests or events.

is_retrybooleanOptional

true | false

retry_kindenumOptional

single | bulk

q or search_termstringOptional

Text search query; search_term is accepted as an alias.

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"
  }
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Request ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

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
  }
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Request ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

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
  }
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Request ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Request body

titlestringOptional

optional short label for the share

expires_in_seconds, ttl_seconds, or ttlintegerOptional

optional TTL in seconds; default 7 days, max 30 days

expires_atdatetimeOptional

optional ISO datetime; clamped to the maximum TTL

redact_keys or redactKeysarrayOptional

optional array of additional header, query, or body keys to redact

include_bodybooleanOptional

optional boolean; set false to omit body content

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
  }
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

tokenstringRequired

Resource ID from the route.

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"
    }
  }
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Request ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Request body

modifications.methodstringOptional

optional HTTP method override

modifications.pathstringOptional

optional request path override

modifications.queryobjectOptional

optional query string or object override

modifications.headersobjectOptional

optional object of replay headers

modifications.bodystringOptional

optional replay body string or JSON value

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
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Request ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

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
    }
  ]
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Request ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

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"
    }
  ]
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Query parameters

bucketenumOptional

all | ongoing | history

limitstringOptional

Maximum number of records to return.

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
    }
  ]
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Request body

fromdatetimeOptional

ISO datetime or relative time, e.g. 2026-04-17T00:00:00.000Z or now-1h

todatetimeOptional

ISO datetime or relative time, e.g. 2026-04-17T23:59:59.999Z or now

statusenumOptional

accepted | rejected

source_idstringOptional

Source ID used to filter inbound requests or routed events.

qstringOptional

Text search query.

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
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Bulk operation ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

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.

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.

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Query parameters

fromdatetimeOptional

ISO datetime or relative time

todatetimeOptional

ISO datetime or relative time

limitintegerOptional

default 100, max 100

cursorstringOptional

opaque next_cursor or next value

statusenumOptional

source_idstringOptional

Source ID used to filter inbound requests or routed events.

connection_idstringOptional

Connection ID used to filter routed requests or events.

destination_idstringOptional

Destination ID used to filter outbound events.

batch_operation_idstringOptional

Bulk operation ID used to filter matching requests or events.

q or search_termstringOptional

Text search query; search_term is accepted as an alias.

Notes

When next_cursor is null, total is exact and total_exact is true.
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"
    }
  ]
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Query parameters

from or ingested_at[gte]datetimeOptional

ISO datetime or relative time

to or ingested_at[lte]datetimeOptional

ISO datetime or relative time

statusenumOptional

source_idstringOptional

Source ID used to filter inbound requests or routed events.

connection_idstringOptional

Connection ID used to filter routed requests or events.

destination_idstringOptional

Destination ID used to filter outbound events.

batch_operation_idstringOptional

Bulk operation ID used to filter matching requests or events.

q or search_termstringOptional

Text search query; search_term is accepted as an alias.

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"
  }
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Event ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

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"
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Event ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

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"
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Query parameters

bucketenumOptional

all | ongoing | history

limitstringOptional

Maximum number of records to return.

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
    }
  ]
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Request body

fromdatetimeOptional

ISO datetime or relative time, e.g. 2026-04-17T00:00:00.000Z or now-1h

todatetimeOptional

ISO datetime or relative time, e.g. 2026-04-17T23:59:59.999Z or now

statusenumOptional

source_idstringOptional

Source ID used to filter inbound requests or routed events.

connection_idstringOptional

Connection ID used to filter routed requests or events.

destination_idstringOptional

Destination ID used to filter outbound events.

qstringOptional

Text search query.

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
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Bulk operation ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

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.

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.

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Query parameters

event_id or event_id[]arrayOptional

Event ID filter. Repeat the parameter to filter by multiple events.

destination_id or destination_id[]arrayOptional

Destination ID filter. Repeat the parameter to filter by multiple destinations.

statusenumOptional

FAILED | SUCCESSFUL

fromdatetimeOptional

ISO timestamp or relative time expression such as now-1h.

todatetimeOptional

ISO timestamp or relative time expression such as now.

qstringOptional

search attempt, event, destination, error code, requested URL, or request ID.

order_bystringOptional

Sort field. Currently created_at.

dirintegerOptional

asc | desc, default desc

limitintegerOptional

default 100, max 255

nextstringOptional

Opaque cursor from pagination.next.

prevstringOptional

Opaque cursor from pagination.prev.

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"
    }
  ]
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Attempt ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Notes

Returns 404 when the attempt does not exist or is outside the active team.

Request

Shell

curl -X GET \
  "https://api.fasthook.io/v1/attempts/att_01jv8cdq6r2t5x9q4m1k0s7p3b" \
  -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.

Response fields

31 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[].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[].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

Six buckets, oldest to newest, of successful transformation executions over the last 24 hours.

models[].executions_24h_failed_bins

Six buckets, oldest to newest, of failed transformation executions over the last 24 hours.

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Query parameters

date_range[start]datetimeRequired

ISO datetime, required

date_range[end]datetimeRequired

ISO datetime, required

granularityenumOptional

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

measures[]arrayOptional

count | accepted_count | rejected_count

source_idstringOptional

Source ID used to filter inbound requests or routed events.

batch_operation_idstringOptional

Bulk operation ID used to filter matching requests or events.

statusenumOptional

accepted | rejected

qstringOptional

Text search query.

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
    }
  ]
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Query parameters

date_range[start]datetimeRequired

ISO datetime, required

date_range[end]datetimeRequired

ISO datetime, required

granularityenumOptional

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

measures[]arrayOptional

source_idstringOptional

Source ID used to filter inbound requests or routed events.

connection_idstringOptional

Connection ID used to filter routed requests or events.

destination_idstringOptional

Destination ID used to filter outbound events.

batch_operation_idstringOptional

Bulk operation ID used to filter matching requests or events.

statusenumOptional

qstringOptional

Text search query.

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
    }
  ]
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Query parameters

idstringOptional

Source ID. Repeat the parameter or pass comma-separated IDs.

idsstringOptional

Alias for id.

source_idstringOptional

Alias for id.

source_idsstringOptional

Alias for id.

Notes

Use this after GET /v1/sources so the source list response stays lightweight.
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
    }
  ]
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Query parameters

idstringOptional

Destination ID. Repeat the parameter or pass comma-separated IDs.

idsstringOptional

Alias for id.

destination_idstringOptional

Alias for id.

destination_idsstringOptional

Alias for id.

Notes

Use this after GET /v1/destinations so the destination list response stays lightweight.
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]
    }
  ]
}

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

Query parameters

idstringOptional

Transformation ID. Repeat the parameter or pass comma-separated IDs.

idsstringOptional

Alias for id.

transformation_idstringOptional

Alias for id.

transformation_idsstringOptional

Alias for id.

Notes

Use this after GET /v1/transformations so the transformation list response stays lightweight.
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.

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.

Input parameters

Route, header, query, and body inputs accepted by this endpoint.

Path parameters

idstringRequired

Source ID.

Headers

AuthorizationstringRequired

Bearer API key or session token.

x-team-idstringOptional

Team to execute the request against. If omitted, FastHook falls back to team_id query and then the demo team.

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"
}

Overview

Routing and tenancy

Input parameters

Headers

Authentication

Response fields

Login with Google

Input parameters

Request body

Login with demo user

Input parameters

Get current profile

Input parameters

Headers

Update profile

Input parameters

Headers

Request body

Notes

Logout

Input parameters

Headers

Sources

Response fields

List sources

Input parameters

Headers

Query parameters

Retrieve a source

Input parameters

Path parameters

Headers

Create a source

Input parameters

Headers

Request body

Notes

Upsert a source

Input parameters

Headers

Request body

Update a source

Input parameters

Path parameters

Headers

Request body

Disable a source

Input parameters

Path parameters

Headers

Notes

Enable a source

Input parameters

Path parameters

Headers

Notes

Delete a source

Input parameters

Path parameters

Headers

Destinations

Response fields

List destinations

Input parameters

Headers

Query parameters

Retrieve a destination

Input parameters

Path parameters

Headers

Create a destination

Input parameters

Headers

Request body

Upsert a destination

Input parameters

Headers

Request body

Replace a destination

Input parameters