Connections

12 operations. Call each with POST https://app.chirply.io/api/v1/actions/<name> and a bearer token; the response is { "data": { "action", "summary", "result" } }. A read badge means the operation changes nothing; write requires the credential’s write scope.

Connected API operations

connections.api_operationsreadadmin only

List every published operation from this account's custom API connections. These operations are shared account capabilities: AI employees, external agents, Copilot and other machine surfaces can inspect the same catalog without receiving stored credentials. Read-only and does not call an external system.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/connections.api_operations \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Test with your API key

Over MCP the same operation is the tool connections_api_operations at https://app.chirply.io/api/mcp, same bearer token, same input.

Call connected API

connections.call_apiwriteconfirmadmin only

Run one published write operation using an account connection. This changes the external system for real and may send messages, alter or delete data, or incur provider charges according to that API. Chirply attaches the encrypted credential server-side, calls only the approved public HTTPS destination, bounds the response and records the execution.

Marked confirm: this operation is irreversible, reaches real people, or spends money. Holding a credential is itself the confirmation for API and MCP callers — call it only when you mean it. The in-app assistant refuses to run it without a human approving first.

Parameters

Field	Type	Required	Description
operation_id	string (uuid)	required	Published write-operation id from connections.api_operations.
input	map of string → object	optional	Arguments matching the operation's published input schema. The operation is executed immediately after approval. Default: {}

Example

curl -X POST https://app.chirply.io/api/v1/actions/connections.call_api \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "operation_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Test with your API key

Over MCP the same operation is the tool connections_call_api at https://app.chirply.io/api/mcp, same bearer token, same input.

Create link

connections.create_linkwriteconfirmadmin only

Create a named link that lets someone OUTSIDE this account — a client, a business owner — connect their own provider account into it. Returns a URL. Anyone who holds that URL can attach an account to this account until it is used once, expires, or is cancelled, so send it only to the person it is meant for. No message is sent by this action; delivering the link is up to you.

Parameters

Field	Type	Required	Description
label	string	required	What to call this link, e.g. "Dad — ads account". Stamped onto every Page, ad account and connection the link produces, so it is how the resulting assets are identified later. Required.
target	string	required	What the client connects. Either a provider id such as "meta" for Facebook & Instagram, or a calendar id such as "calendar:google". Call connections.providers for the exact list that can be requested.
domain_id	string (uuid)	optional	Verified domain id from connections.list_domains. Omit to use the account's default branded domain.
note	string	optional	A short message shown to the client on the page, in your own words. Optional.
expires_in_days	integer	optional	How many days the link stays usable. 1–90, defaults to 14. Default: 14
contact_id	string (uuid)	optional	The contact being asked, so the grant lands on their timeline.

Example

curl -X POST https://app.chirply.io/api/v1/actions/connections.create_link \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "example",
    "target": "example"
  }'

Test with your API key

Over MCP the same operation is the tool connections_create_link at https://app.chirply.io/api/mcp, same bearer token, same input.

Open a connection link

connections.get_linkreadadmin only

Fetch one client connection link by id, INCLUDING the URL to send. Anyone holding that URL can connect an account into this account until it is used, expires, or is cancelled — treat it as a credential and send it only to the intended person.

Parameters

Field	Type	Required	Description
id	string (uuid)	required	The connection link's id.

Example

curl -X POST https://app.chirply.io/api/v1/actions/connections.get_link \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Test with your API key

Over MCP the same operation is the tool connections_get_link at https://app.chirply.io/api/mcp, same bearer token, same input.

List connection link domains

connections.list_domainsreadadmin only

List the active, verified web domains this account can use for client connection links, including its parent agency's domains. Read-only; no DNS changes are made.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/connections.list_domains \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Test with your API key

Over MCP the same operation is the tool connections_list_domains at https://app.chirply.io/api/mcp, same bearer token, same input.

Links you've sent

connections.list_linksreadadmin only

List this account's client connection links, newest first, with whether each one is still waiting, already connected, expired or cancelled. The link URL itself is NOT included — fetch a single link with connections.get_link to get it.

Parameters

Field	Type	Required	Description
limit	integer	optional	How many links to return. Defaults to 50. Default: 50
offset	integer	optional	How many links to skip, for paging. Default: 0
target	string	optional	Only links for this target, e.g. "meta" or "calendar:google".

Example

curl -X POST https://app.chirply.io/api/v1/actions/connections.list_links \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "limit": 50,
    "offset": 0
  }'

Test with your API key

Over MCP the same operation is the tool connections_list_links at https://app.chirply.io/api/mcp, same bearer token, same input.

Get setup instructions

connections.prepare_webhook_setupwriteconfirmadmin only

Prepare the private BookFunnel webhook URL for a pending client connection link. Creates or reuses the account's webhook connection; no subscribers are imported or messages sent by this action. The returned URL is a credential and must only be shared with the intended account owner.

Parameters

Field	Type	Required	Description
id	string (uuid)	required	The pending BookFunnel connection link id in this account.

Example

curl -X POST https://app.chirply.io/api/v1/actions/connections.prepare_webhook_setup \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Test with your API key

Over MCP the same operation is the tool connections_prepare_webhook_setup at https://app.chirply.io/api/mcp, same bearer token, same input.

List connectable providers

connections.providersreadadmin only

List supported client connection targets and their availability. Each entry includes available and reason: platform setup or approval must be complete before creating a link. Mode oauth uses the provider's consent screen, form collects a key, and setup gives guided instructions. Use the returned target when creating a link. Read-only; no accounts are connected.

Parameters

No parameters — POST an empty body.

Example

curl -X POST https://app.chirply.io/api/v1/actions/connections.providers \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{}'

Test with your API key

Over MCP the same operation is the tool connections_providers at https://app.chirply.io/api/mcp, same bearer token, same input.

Read from connected API

connections.read_apireadadmin only

Run one published read-only operation using an account connection. Chirply attaches the encrypted credential server-side, calls only the connection's approved public HTTPS destination, bounds the response and records the execution. Does not change the external system, though the provider may charge for API reads under its own terms.

Parameters

Field	Type	Required	Description
operation_id	string (uuid)	required	Published read-operation id from connections.api_operations.
input	map of string → object	optional	Arguments matching the operation's published input schema. Default: {}

Example

curl -X POST https://app.chirply.io/api/v1/actions/connections.read_api \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "operation_id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Test with your API key

Over MCP the same operation is the tool connections_read_api at https://app.chirply.io/api/mcp, same bearer token, same input.

Cancel link

connections.revoke_linkwriteconfirmadmin only

Cancel a connection link that hasn't been used. It stops working immediately, including for someone part-way through the provider's login screen. This cannot be undone — issue a new link instead. Any connection the link ALREADY produced keeps working; disconnecting that is a separate action on the integration itself.

Parameters

Field	Type	Required	Description
id	string (uuid)	required	The connection link's id.

Example

curl -X POST https://app.chirply.io/api/v1/actions/connections.revoke_link \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Test with your API key

Over MCP the same operation is the tool connections_revoke_link at https://app.chirply.io/api/mcp, same bearer token, same input.

Submit client API credentials

connections.submit_api_credentialswriteconfirmadmin only

Complete a pending custom API connection request in this account. Stores the supplied credential encrypted and closes the link atomically. Does not call the external API or publish an agent tool; the connection becomes available for account tools to use.

Parameters

Field	Type	Required	Description
id	string (uuid)	required	Pending custom API connection link id.
base_url	string (uri)	required	Public HTTPS API base URL.
auth_type	"none" \| "bearer" \| "basic" \| "api_key"	required	API authentication scheme.
secret	string	optional	API key, bearer token, or Basic password; encrypted before storage.
username	string	optional	Basic-auth username.
api_key_header	string	optional	Header name for API key authentication. Default: "X-API-Key"

Example

curl -X POST https://app.chirply.io/api/v1/actions/connections.submit_api_credentials \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11",
    "base_url": "https://example.com",
    "auth_type": "none"
  }'

Test with your API key

Over MCP the same operation is the tool connections_submit_api_credentials at https://app.chirply.io/api/mcp, same bearer token, same input.

Connect Stripe (your own)

connections.submit_stripe_credentialswriteconfirmadmin only

Complete a pending Stripe key-entry link in this account. Verifies the live secret key with Stripe, encrypts it, registers the account and closes the link atomically. May register a payment-events webhook for CRM sync. The first Stripe account becomes the fallback seller; existing sellers are preserved. Does not charge anyone, send messages, or move money.

Parameters

Field	Type	Required	Description
secret_key	string	required	Live Stripe secret key; verified with Stripe, encrypted, and never returned.
publishable_key	string	required	Public pk_live_ key used by payment forms.
webhook_secret	string	optional	Existing Stripe webhook signing secret, when the account already has a configured endpoint.
id	string (uuid)	required	Pending Stripe key-entry connection link id in this account.

Example

curl -X POST https://app.chirply.io/api/v1/actions/connections.submit_stripe_credentials \
  -H "Authorization: Bearer chp_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "secret_key": "example",
    "publishable_key": "example",
    "id": "2f6a1c1e-6c3b-4c62-9f6e-8a2d4b7c9e11"
  }'

Test with your API key

Over MCP the same operation is the tool connections_submit_stripe_credentials at https://app.chirply.io/api/mcp, same bearer token, same input.