Hookdeck

This is the fastest way to get a connection. The URL is normalized to a domain and matched against known apps. If no app is found, one is created and a connector is built automatically.

If the returned connection has state: "READY", skip to Step 2.

#### 1b. Wait for the connection to be ready

If the connection is in BUILDING state, poll until it's ready:

npx @membranehq/cli connection get  --wait --json

The --wait flag long-polls (up to --timeout seconds, default 30) until the state changes. Keep polling until state is no longer BUILDING.

The resulting state tells you what to do next:

After the user completes the action (e.g. authenticates in the browser), poll again with membrane connection get --json to check if the state moved to READY.

Searching for actions

Search using a natural language description of what you want to do:

membrane action list --connectionId=CONNECTION_ID --intent "QUERY" --limit 10 --json

You should always search for actions in the context of a specific connection.

Each result includes id, name, description, inputSchema (what parameters the action accepts), and outputSchema (what it returns).

Popular actions

| Name | Key | Description | |---|---|---| | List Connections | list-connections | Retrieve a list of connections (source-to-destination links) with optional filtering and pagination | | List Destinations | list-destinations | Retrieve a list of destinations with optional filtering and pagination | | List Sources | list-sources | Retrieve a list of webhook sources with optional filtering and pagination | | List Events | list-events | Retrieve a list of events (delivery attempts to destinations) with filtering and pagination | | List Requests | list-requests | List all requests with optional filtering | | List Attempts | list-attempts | List all delivery attempts with optional filtering | | List Transformations | list-transformations | List all transformations with optional filtering | | List Issues | list-issues | List all issues with optional filtering | | Get Connection | get-connection | Retrieve a single connection by ID | | Get Destination | get-destination | Retrieve a single destination by ID | | Get Source | get-source | Retrieve a single source by ID | | Get Event | get-event | Retrieve a single event by ID | | Get Request | get-request | Retrieve a single request by ID | | Get Attempt | get-attempt | Retrieve a single delivery attempt by ID | | Get Transformation | get-transformation | Retrieve a single transformation by ID | | Get Issue | get-issue | Retrieve a single issue by ID | | Create Connection | create-connection | Create a new connection linking a source to a destination. | | Create Destination | create-destination | Create a new destination endpoint | | Create Source | create-source | Create a new webhook source | | Update Connection | update-connection | Update an existing connection |

Running actions

membrane action run  --connectionId=CONNECTION_ID --json

To pass JSON parameters:

membrane action run  --connectionId=CONNECTION_ID --input '{"key": "value"}' --json

The result is in the output field of the response.

Proxy requests

When the available actions don't cover your use case, you can send requests directly to the Hookdeck API through Membrane's proxy. Membrane automatically appends the base URL to the path you provide and injects the correct authentication headers — including transparent credential refresh if they expire.

membrane request CONNECTION_ID /path/to/endpoint

Common options:

| Flag | Description | |------|-------------| | -X, --method | HTTP method (GET, POST, PUT, PATCH, DELETE). Defaults to GET | | -H, --header | Add a request header (repeatable), e.g. -H "Accept: application/json" | | -d, --data | Request body (string) | | --json | Shorthand to send a JSON body and set Content-Type: application/json | | --rawData | Send the body as-is without any processing | | --query | Query-string parameter (repeatable), e.g. --query "limit=10" | | --pathParam | Path parameter (repeatable), e.g. --pathParam "id=123" |

Best practices