/hookdeck-connections | Type: Application | PCID required: Yes
Tools
hookdeck_connections_count_connections
Count connections Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
destination_id | string[] | No | — | Filter by associated destination IDs |
source_id | string[] | No | — | Filter by associated source IDs |
disabled | boolean | No | — | Include disabled resources in the response |
disabled_at | object | No | — | Date the connection was disabled |
paused_at | object | No | — | Date the connection was paused |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"destination_id": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter by associated destination IDs"
},
"source_id": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter by associated source IDs"
},
"disabled": {
"type": "boolean",
"description": "Include disabled resources in the response"
},
"disabled_at": {
"description": "Date the connection was disabled"
},
"paused_at": {
"description": "Date the connection was paused"
}
},
"required": [
"PCID"
]
}
hookdeck_connections_count_destinations
Count destinations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string[] | No | — | Filter by destination IDs |
name | string[] | No | — | The destination name |
disabled | boolean | No | — | Include disabled resources in the response |
disabled_at | string[] | No | — | Date the destination was disabled |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter by destination IDs"
},
"name": {
"type": "array",
"items": {
"type": "string"
},
"description": "The destination name"
},
"disabled": {
"type": "boolean",
"description": "Include disabled resources in the response"
},
"disabled_at": {
"type": "array",
"items": {
"type": "string",
"format": "date-time"
},
"description": "Date the destination was disabled"
}
},
"required": [
"PCID"
]
}
hookdeck_connections_count_sources
Count sourcesShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
hookdeck_connections_create_connection
Create a connection Parameters:| Parameter | Type | Required | Default | Description | |
|---|---|---|---|---|---|
description | string | null | No | — | Description for the connection |
destination | object | No | — | Destination input object | |
destination_id | string | null | No | — | ID of a destination to bind to the connection |
name | string | null | No | — | A unique name of the connection for the source |
rules | any[] | No | — | The rules value | |
source | object | No | — | Source input object | |
source_id | string | null | No | — | ID of a source to bind to the connection |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"description": {
"type": [
"string",
"null"
],
"description": "Description for the connection"
},
"destination": {
"type": "object",
"description": "Destination input object",
"properties": {
"name": {
"type": "string",
"description": "Name for the destination"
},
"type": {
"type": "string",
"description": "Type of the destination",
"enum": [
"HTTP",
"CLI",
"MOCK_API"
]
},
"description": {
"type": "string",
"description": "Description for the destination"
},
"config": {
"type": "object",
"description": "The type configs for the specified type"
}
},
"required": [
"name"
]
},
"destination_id": {
"type": [
"string",
"null"
],
"description": "ID of a destination to bind to the connection"
},
"name": {
"type": [
"string",
"null"
],
"description": "A unique name of the connection for the source"
},
"rules": {
"type": "array",
"description": "The rules value"
},
"source": {
"type": "object",
"description": "Source input object",
"properties": {
"name": {
"type": "string",
"description": "A unique name for the source"
},
"type": {
"type": "string",
"description": "Type of the source",
"enum": [
"AIPRISE",
"ALCHEMY",
"DOCUSIGN",
"INTERCOM",
"PUBLISH_API",
"WEBHOOK",
"HTTP",
"MANAGED",
"HOOKDECK_OUTPOST",
"SANITY",
"BIGCOMMERCE",
"OPENAI",
"POLAR",
"BRIDGE_XYZ",
"BRIDGE_API",
"CHARGEBEE_BILLING",
"CHAINDOTS",
"CLOUDSIGNAL",
"COINBASE",
"COURIER",
"CURSOR",
"MERAKI",
"MICROSOFT_GRAPH",
"MICROSOFT_SHAREPOINT",
"FIREBLOCKS",
"FRONTAPP",
"ZOOM",
"TWITTER",
"RECHARGE",
"RECURLY",
"RING_CENTRAL",
"STRIPE",
"PROPERTY-FINDER",
"QUOTER",
"SHOPIFY",
"TWILIO",
"GITHUB",
"POSTMARK",
"TALLY",
"TYPEFORM",
"PICQER",
"XERO",
"SVIX",
"RESEND",
"ADYEN",
"AKENEO",
"GITLAB",
"WOOCOMMERCE",
"OKTA",
"OURA",
"COMMERCELAYER",
"HUBSPOT",
"MAILGUN",
"PERSONA",
"PIPEDRIVE",
"SENDGRID",
"WORKOS",
"SYNCTERA",
"AWS_SNS",
"THREE_D_EYE",
"TWITCH",
"ENODE",
"FAUNDIT",
"FAVRO",
"LINEAR",
"SHIPHERO",
"SHOPLINE",
"WIX",
"NMI",
"ORB",
"PYLON",
"RAZORPAY",
"REPAY",
"SQUARE",
"SOLIDGATE",
"TRELLO",
"EBAY",
"TELNYX",
"DISCORD",
"TOKENIO",
"FISERV",
"FUSIONAUTH",
"BONDSMITH",
"VERCEL_LOG_DRAINS",
"VERCEL",
"TEBEX",
"SLACK",
"SMARTCAR",
"MAILCHIMP",
"NUVEMSHOP",
"PADDLE",
"PAYPAL",
"PAYSTACK",
"PORTAL",
"TREEZOR",
"PRAXIS",
"CUSTOMERIO",
"EXACT_ONLINE",
"FACEBOOK",
"WHATSAPP",
"REPLICATE",
"TIKTOK",
"TIKTOK_SHOP",
"AIRWALLEX",
"ASCEND",
"ALIPAY",
"ZENDESK",
"UPOLLO",
"SMILE",
"NYLAS",
"CLIO",
"GOCARDLESS",
"LINKEDIN",
"LITHIC",
"STRAVA",
"UTILA",
"MONDAY",
"ZEROHASH",
"ZIFT",
"ETHOCA",
"AIRTABLE",
"ASANA",
"FASTSPRING",
"PAYPRO_GLOBAL",
"USPS",
"FLEXPORT",
"UBER",
"CIRCLE"
]
},
"description": {
"type": "string",
"description": "Description for the source"
},
"config": {
"type": "object",
"description": "The type configs for the specified type"
}
},
"required": [
"name"
]
},
"source_id": {
"type": [
"string",
"null"
],
"description": "ID of a source to bind to the connection"
}
},
"required": [
"PCID"
]
}
hookdeck_connections_create_destination
Create a destination Parameters:| Parameter | Type | Required | Default | Description | |
|---|---|---|---|---|---|
config | object | No | — | The type configs for the specified type | |
description | string | null | No | — | Description for the destination |
name | string | Yes | — | Name for the destination | |
type | string | No | — | Type of the destination |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"config": {
"type": "object",
"description": "The type configs for the specified type"
},
"description": {
"type": [
"string",
"null"
],
"description": "Description for the destination"
},
"name": {
"type": "string",
"description": "Name for the destination"
},
"type": {
"type": "string",
"description": "Type of the destination",
"enum": [
"HTTP",
"CLI",
"MOCK_API"
]
}
},
"required": [
"PCID",
"name"
]
}
hookdeck_connections_create_source
Create a source Parameters:| Parameter | Type | Required | Default | Description | |
|---|---|---|---|---|---|
config | object | No | — | The type configs for the specified type | |
description | string | null | No | — | Description for the source |
name | string | Yes | — | A unique name for the source | |
type | string | No | — | Type of the source |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"config": {
"type": "object",
"description": "The type configs for the specified type"
},
"description": {
"type": [
"string",
"null"
],
"description": "Description for the source"
},
"name": {
"type": "string",
"description": "A unique name for the source"
},
"type": {
"type": "string",
"description": "Type of the source",
"enum": [
"AIPRISE",
"ALCHEMY",
"DOCUSIGN",
"INTERCOM",
"PUBLISH_API",
"WEBHOOK",
"HTTP",
"MANAGED",
"HOOKDECK_OUTPOST",
"SANITY",
"BIGCOMMERCE",
"OPENAI",
"POLAR",
"BRIDGE_XYZ",
"BRIDGE_API",
"CHARGEBEE_BILLING",
"CHAINDOTS",
"CLOUDSIGNAL",
"COINBASE",
"COURIER",
"CURSOR",
"MERAKI",
"MICROSOFT_GRAPH",
"MICROSOFT_SHAREPOINT",
"FIREBLOCKS",
"FRONTAPP",
"ZOOM",
"TWITTER",
"RECHARGE",
"RECURLY",
"RING_CENTRAL",
"STRIPE",
"PROPERTY-FINDER",
"QUOTER",
"SHOPIFY",
"TWILIO",
"GITHUB",
"POSTMARK",
"TALLY",
"TYPEFORM",
"PICQER",
"XERO",
"SVIX",
"RESEND",
"ADYEN",
"AKENEO",
"GITLAB",
"WOOCOMMERCE",
"OKTA",
"OURA",
"COMMERCELAYER",
"HUBSPOT",
"MAILGUN",
"PERSONA",
"PIPEDRIVE",
"SENDGRID",
"WORKOS",
"SYNCTERA",
"AWS_SNS",
"THREE_D_EYE",
"TWITCH",
"ENODE",
"FAUNDIT",
"FAVRO",
"LINEAR",
"SHIPHERO",
"SHOPLINE",
"WIX",
"NMI",
"ORB",
"PYLON",
"RAZORPAY",
"REPAY",
"SQUARE",
"SOLIDGATE",
"TRELLO",
"EBAY",
"TELNYX",
"DISCORD",
"TOKENIO",
"FISERV",
"FUSIONAUTH",
"BONDSMITH",
"VERCEL_LOG_DRAINS",
"VERCEL",
"TEBEX",
"SLACK",
"SMARTCAR",
"MAILCHIMP",
"NUVEMSHOP",
"PADDLE",
"PAYPAL",
"PAYSTACK",
"PORTAL",
"TREEZOR",
"PRAXIS",
"CUSTOMERIO",
"EXACT_ONLINE",
"FACEBOOK",
"WHATSAPP",
"REPLICATE",
"TIKTOK",
"TIKTOK_SHOP",
"AIRWALLEX",
"ASCEND",
"ALIPAY",
"ZENDESK",
"UPOLLO",
"SMILE",
"NYLAS",
"CLIO",
"GOCARDLESS",
"LINKEDIN",
"LITHIC",
"STRAVA",
"UTILA",
"MONDAY",
"ZEROHASH",
"ZIFT",
"ETHOCA",
"AIRTABLE",
"ASANA",
"FASTSPRING",
"PAYPRO_GLOBAL",
"USPS",
"FLEXPORT",
"UBER",
"CIRCLE"
]
}
},
"required": [
"PCID",
"name"
]
}
hookdeck_connections_delete_connection
Delete a connection Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
hookdeck_connections_delete_destination
Delete a destination Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
hookdeck_connections_delete_source
Delete a source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The id value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The id value"
}
},
"required": [
"PCID",
"id"
]
}
hookdeck_connections_disable_connection
Disable a connection Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Connection ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Connection ID"
}
},
"required": [
"PCID",
"id"
]
}
hookdeck_connections_disable_connection_archive
Disable a connection Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Connection ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Connection ID"
}
},
"required": [
"PCID",
"id"
]
}
hookdeck_connections_disable_destination
Disable a destination Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Destination ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Destination ID"
}
},
"required": [
"PCID",
"id"
]
}
hookdeck_connections_disable_destination_archive
Disable a destination Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Destination ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Destination ID"
}
},
"required": [
"PCID",
"id"
]
}
hookdeck_connections_disable_source
Disable a source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Source ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Source ID"
}
},
"required": [
"PCID",
"id"
]
}
hookdeck_connections_disable_source_archive
Disable a source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Source ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Source ID"
}
},
"required": [
"PCID",
"id"
]
}
hookdeck_connections_enable_connection
Enable a connection Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Connection ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Connection ID"
}
},
"required": [
"PCID",
"id"
]
}
hookdeck_connections_enable_connection_unarchive
Enable a connection Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Connection ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Connection ID"
}
},
"required": [
"PCID",
"id"
]
}
hookdeck_connections_enable_destination
Enable a destination Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Destination ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Destination ID"
}
},
"required": [
"PCID",
"id"
]
}
hookdeck_connections_enable_destination_unarchive
Enable a destination Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Destination ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Destination ID"
}
},
"required": [
"PCID",
"id"
]
}
hookdeck_connections_enable_source
Enable a source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Source ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Source ID"
}
},
"required": [
"PCID",
"id"
]
}
hookdeck_connections_enable_source_unarchive
Enable a source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Source ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Source ID"
}
},
"required": [
"PCID",
"id"
]
}
hookdeck_connections_get_connection
Get a single connection Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Connection ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Connection ID"
}
},
"required": [
"PCID",
"id"
]
}
hookdeck_connections_get_connections
Get connections Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string[] | No | — | Filter by connection IDs |
name | object | No | — | Filter by connection name |
destination_id | string[] | No | — | Filter by associated destination IDs |
source_id | string[] | No | — | Filter by associated source IDs |
disabled | boolean | No | — | Include disabled resources in the response |
disabled_at | object | No | — | Date the connection was disabled |
full_name | string | No | — | Fuzzy match the concatenated source and connection name. The source name and connection name must be separated by ” -> “ |
paused_at | object | No | — | Date the connection was paused |
order_by | string[] | No | — | Sort key(s) |
dir | string[] | No | — | Sort direction(s) |
limit | integer | No | — | Result set size |
next | string | No | — | The ID to provide in the query to get the next set of results |
prev | string | No | — | The ID to provide in the query to get the previous set of results |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter by connection IDs"
},
"name": {
"description": "Filter by connection name"
},
"destination_id": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter by associated destination IDs"
},
"source_id": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter by associated source IDs"
},
"disabled": {
"type": "boolean",
"description": "Include disabled resources in the response"
},
"disabled_at": {
"description": "Date the connection was disabled"
},
"full_name": {
"type": "string",
"description": "Fuzzy match the concatenated source and connection name. The source name and connection name must be separated by \" -> \""
},
"paused_at": {
"description": "Date the connection was paused"
},
"order_by": {
"type": "array",
"items": {
"type": "string",
"enum": [
"full_name",
"created_at",
"updated_at",
"sources.updated_at",
"sources.created_at",
"destinations.updated_at",
"destinations.created_at"
]
},
"description": "Sort key(s)"
},
"dir": {
"type": "array",
"items": {
"type": "string",
"enum": [
"asc",
"desc"
]
},
"description": "Sort direction(s)"
},
"limit": {
"type": "integer",
"description": "Result set size"
},
"next": {
"type": "string",
"description": "The ID to provide in the query to get the next set of results"
},
"prev": {
"type": "string",
"description": "The ID to provide in the query to get the previous set of results"
}
},
"required": [
"PCID"
]
}
hookdeck_connections_get_destination
Get a destination Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | Related resources to include |
id | string | Yes | — | Destination ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"include": {
"type": "string",
"description": "Related resources to include",
"enum": [
"config.auth"
]
},
"id": {
"type": "string",
"description": "Destination ID"
}
},
"required": [
"PCID",
"id"
]
}
hookdeck_connections_get_destinations
Get destinations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string[] | No | — | Filter by destination IDs |
name | object | No | — | The destination name |
type | string[] | No | — | Filter by destination type |
disabled | boolean | No | — | Include disabled resources in the response |
disabled_at | object | No | — | Date the destination was disabled |
order_by | string | No | — | Sort key |
dir | string | No | — | Sort direction |
limit | integer | No | — | Result set size |
next | string | No | — | The ID to provide in the query to get the next set of results |
prev | string | No | — | The ID to provide in the query to get the previous set of results |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter by destination IDs"
},
"name": {
"description": "The destination name"
},
"type": {
"type": "array",
"items": {
"type": "string",
"enum": [
"HTTP",
"CLI",
"MOCK_API"
]
},
"description": "Filter by destination type"
},
"disabled": {
"type": "boolean",
"description": "Include disabled resources in the response"
},
"disabled_at": {
"description": "Date the destination was disabled"
},
"order_by": {
"type": "string",
"description": "Sort key",
"enum": [
"name",
"created_at",
"updated_at"
]
},
"dir": {
"type": "string",
"description": "Sort direction",
"enum": [
"asc",
"desc"
]
},
"limit": {
"type": "integer",
"description": "Result set size"
},
"next": {
"type": "string",
"description": "The ID to provide in the query to get the next set of results"
},
"prev": {
"type": "string",
"description": "The ID to provide in the query to get the previous set of results"
}
},
"required": [
"PCID"
]
}
hookdeck_connections_get_source
Get a source Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include | string | No | — | Related resources to include |
id | string | Yes | — | Source ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"include": {
"type": "string",
"description": "Related resources to include",
"enum": [
"config.auth"
]
},
"id": {
"type": "string",
"description": "Source ID"
}
},
"required": [
"PCID",
"id"
]
}
hookdeck_connections_get_sources
Get sources Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string[] | No | — | Filter by source IDs |
name | object | No | — | The source name |
type | string[] | No | — | Filter by source type |
disabled | boolean | No | — | Include disabled resources in the response |
disabled_at | object | No | — | Date the source was disabled |
order_by | string | No | — | Sort key |
dir | string | No | — | Sort direction |
limit | integer | No | — | Result set size |
next | string | No | — | The ID to provide in the query to get the next set of results |
prev | string | No | — | The ID to provide in the query to get the previous set of results |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter by source IDs"
},
"name": {
"description": "The source name"
},
"type": {
"type": "array",
"items": {
"type": "string",
"enum": [
"AIPRISE",
"ALCHEMY",
"DOCUSIGN",
"INTERCOM",
"PUBLISH_API",
"WEBHOOK",
"HTTP",
"MANAGED",
"HOOKDECK_OUTPOST",
"SANITY",
"BIGCOMMERCE",
"OPENAI",
"POLAR",
"BRIDGE_XYZ",
"BRIDGE_API",
"CHARGEBEE_BILLING",
"CHAINDOTS",
"CLOUDSIGNAL",
"COINBASE",
"COURIER",
"CURSOR",
"MERAKI",
"MICROSOFT_GRAPH",
"MICROSOFT_SHAREPOINT",
"FIREBLOCKS",
"FRONTAPP",
"ZOOM",
"TWITTER",
"RECHARGE",
"RECURLY",
"RING_CENTRAL",
"STRIPE",
"PROPERTY-FINDER",
"QUOTER",
"SHOPIFY",
"TWILIO",
"GITHUB",
"POSTMARK",
"TALLY",
"TYPEFORM",
"PICQER",
"XERO",
"SVIX",
"RESEND",
"ADYEN",
"AKENEO",
"GITLAB",
"WOOCOMMERCE",
"OKTA",
"OURA",
"COMMERCELAYER",
"HUBSPOT",
"MAILGUN",
"PERSONA",
"PIPEDRIVE",
"SENDGRID",
"WORKOS",
"SYNCTERA",
"AWS_SNS",
"THREE_D_EYE",
"TWITCH",
"ENODE",
"FAUNDIT",
"FAVRO",
"LINEAR",
"SHIPHERO",
"SHOPLINE",
"WIX",
"NMI",
"ORB",
"PYLON",
"RAZORPAY",
"REPAY",
"SQUARE",
"SOLIDGATE",
"TRELLO",
"EBAY",
"TELNYX",
"DISCORD",
"TOKENIO",
"FISERV",
"FUSIONAUTH",
"BONDSMITH",
"VERCEL_LOG_DRAINS",
"VERCEL",
"TEBEX",
"SLACK",
"SMARTCAR",
"MAILCHIMP",
"NUVEMSHOP",
"PADDLE",
"PAYPAL",
"PAYSTACK",
"PORTAL",
"TREEZOR",
"PRAXIS",
"CUSTOMERIO",
"EXACT_ONLINE",
"FACEBOOK",
"WHATSAPP",
"REPLICATE",
"TIKTOK",
"TIKTOK_SHOP",
"AIRWALLEX",
"ASCEND",
"ALIPAY",
"ZENDESK",
"UPOLLO",
"SMILE",
"NYLAS",
"CLIO",
"GOCARDLESS",
"LINKEDIN",
"LITHIC",
"STRAVA",
"UTILA",
"MONDAY",
"ZEROHASH",
"ZIFT",
"ETHOCA",
"AIRTABLE",
"ASANA",
"FASTSPRING",
"PAYPRO_GLOBAL",
"USPS",
"FLEXPORT",
"UBER",
"CIRCLE"
]
},
"description": "Filter by source type"
},
"disabled": {
"type": "boolean",
"description": "Include disabled resources in the response"
},
"disabled_at": {
"description": "Date the source was disabled"
},
"order_by": {
"type": "string",
"description": "Sort key",
"enum": [
"name",
"created_at",
"updated_at"
]
},
"dir": {
"type": "string",
"description": "Sort direction",
"enum": [
"asc",
"desc"
]
},
"limit": {
"type": "integer",
"description": "Result set size"
},
"next": {
"type": "string",
"description": "The ID to provide in the query to get the next set of results"
},
"prev": {
"type": "string",
"description": "The ID to provide in the query to get the previous set of results"
}
},
"required": [
"PCID"
]
}
hookdeck_connections_pause_connection
Pause a connection Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Connection ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Connection ID"
}
},
"required": [
"PCID",
"id"
]
}
hookdeck_connections_unpause_connection
Unpause a connection Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | Connection ID |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Connection ID"
}
},
"required": [
"PCID",
"id"
]
}
hookdeck_connections_update_connection
Update a connection Parameters:| Parameter | Type | Required | Default | Description | |
|---|---|---|---|---|---|
id | string | Yes | — | Connection ID | |
description | string | null | No | — | Description for the connection |
name | string | null | No | — | The name value |
rules | any[] | No | — | The rules value |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Connection ID"
},
"description": {
"type": [
"string",
"null"
],
"description": "Description for the connection"
},
"name": {
"type": [
"string",
"null"
],
"description": "The name value"
},
"rules": {
"type": "array",
"description": "The rules value"
}
},
"required": [
"PCID",
"id"
]
}
hookdeck_connections_update_destination
Update a destination Parameters:| Parameter | Type | Required | Default | Description | |
|---|---|---|---|---|---|
id | string | Yes | — | Destination ID | |
config | object | No | — | The type configs for the specified type | |
description | string | null | No | — | Description for the destination |
name | string | No | — | Name for the destination | |
type | string | No | — | Type of the destination |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Destination ID"
},
"config": {
"type": "object",
"description": "The type configs for the specified type"
},
"description": {
"type": [
"string",
"null"
],
"description": "Description for the destination"
},
"name": {
"type": "string",
"description": "Name for the destination"
},
"type": {
"type": "string",
"description": "Type of the destination",
"enum": [
"HTTP",
"CLI",
"MOCK_API"
]
}
},
"required": [
"PCID",
"id"
]
}
hookdeck_connections_update_source
Update a source Parameters:| Parameter | Type | Required | Default | Description | |
|---|---|---|---|---|---|
id | string | Yes | — | Source ID | |
config | object | No | — | The type configs for the specified type | |
description | string | null | No | — | Description for the source |
name | string | No | — | A unique name for the source | |
type | string | No | — | Type of the source |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "Source ID"
},
"config": {
"type": "object",
"description": "The type configs for the specified type"
},
"description": {
"type": [
"string",
"null"
],
"description": "Description for the source"
},
"name": {
"type": "string",
"description": "A unique name for the source"
},
"type": {
"type": "string",
"description": "Type of the source",
"enum": [
"AIPRISE",
"ALCHEMY",
"DOCUSIGN",
"INTERCOM",
"PUBLISH_API",
"WEBHOOK",
"HTTP",
"MANAGED",
"HOOKDECK_OUTPOST",
"SANITY",
"BIGCOMMERCE",
"OPENAI",
"POLAR",
"BRIDGE_XYZ",
"BRIDGE_API",
"CHARGEBEE_BILLING",
"CHAINDOTS",
"CLOUDSIGNAL",
"COINBASE",
"COURIER",
"CURSOR",
"MERAKI",
"MICROSOFT_GRAPH",
"MICROSOFT_SHAREPOINT",
"FIREBLOCKS",
"FRONTAPP",
"ZOOM",
"TWITTER",
"RECHARGE",
"RECURLY",
"RING_CENTRAL",
"STRIPE",
"PROPERTY-FINDER",
"QUOTER",
"SHOPIFY",
"TWILIO",
"GITHUB",
"POSTMARK",
"TALLY",
"TYPEFORM",
"PICQER",
"XERO",
"SVIX",
"RESEND",
"ADYEN",
"AKENEO",
"GITLAB",
"WOOCOMMERCE",
"OKTA",
"OURA",
"COMMERCELAYER",
"HUBSPOT",
"MAILGUN",
"PERSONA",
"PIPEDRIVE",
"SENDGRID",
"WORKOS",
"SYNCTERA",
"AWS_SNS",
"THREE_D_EYE",
"TWITCH",
"ENODE",
"FAUNDIT",
"FAVRO",
"LINEAR",
"SHIPHERO",
"SHOPLINE",
"WIX",
"NMI",
"ORB",
"PYLON",
"RAZORPAY",
"REPAY",
"SQUARE",
"SOLIDGATE",
"TRELLO",
"EBAY",
"TELNYX",
"DISCORD",
"TOKENIO",
"FISERV",
"FUSIONAUTH",
"BONDSMITH",
"VERCEL_LOG_DRAINS",
"VERCEL",
"TEBEX",
"SLACK",
"SMARTCAR",
"MAILCHIMP",
"NUVEMSHOP",
"PADDLE",
"PAYPAL",
"PAYSTACK",
"PORTAL",
"TREEZOR",
"PRAXIS",
"CUSTOMERIO",
"EXACT_ONLINE",
"FACEBOOK",
"WHATSAPP",
"REPLICATE",
"TIKTOK",
"TIKTOK_SHOP",
"AIRWALLEX",
"ASCEND",
"ALIPAY",
"ZENDESK",
"UPOLLO",
"SMILE",
"NYLAS",
"CLIO",
"GOCARDLESS",
"LINKEDIN",
"LITHIC",
"STRAVA",
"UTILA",
"MONDAY",
"ZEROHASH",
"ZIFT",
"ETHOCA",
"AIRTABLE",
"ASANA",
"FASTSPRING",
"PAYPRO_GLOBAL",
"USPS",
"FLEXPORT",
"UBER",
"CIRCLE"
]
}
},
"required": [
"PCID",
"id"
]
}
hookdeck_connections_upsert_connection
Update or create a connection Parameters:| Parameter | Type | Required | Default | Description | |
|---|---|---|---|---|---|
description | string | null | No | — | Description for the connection |
destination | object | No | — | Destination input object | |
destination_id | string | null | No | — | ID of a destination to bind to the connection |
name | string | null | No | — | A unique name of the connection for the source |
rules | any[] | No | — | The rules value | |
source | object | No | — | Source input object | |
source_id | string | null | No | — | ID of a source to bind to the connection |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"description": {
"type": [
"string",
"null"
],
"description": "Description for the connection"
},
"destination": {
"type": "object",
"description": "Destination input object",
"properties": {
"name": {
"type": "string",
"description": "Name for the destination"
},
"type": {
"type": "string",
"description": "Type of the destination",
"enum": [
"HTTP",
"CLI",
"MOCK_API"
]
},
"description": {
"type": "string",
"description": "Description for the destination"
},
"config": {
"type": "object",
"description": "The type configs for the specified type"
}
},
"required": [
"name"
]
},
"destination_id": {
"type": [
"string",
"null"
],
"description": "ID of a destination to bind to the connection"
},
"name": {
"type": [
"string",
"null"
],
"description": "A unique name of the connection for the source"
},
"rules": {
"type": "array",
"description": "The rules value"
},
"source": {
"type": "object",
"description": "Source input object",
"properties": {
"name": {
"type": "string",
"description": "A unique name for the source"
},
"type": {
"type": "string",
"description": "Type of the source",
"enum": [
"AIPRISE",
"ALCHEMY",
"DOCUSIGN",
"INTERCOM",
"PUBLISH_API",
"WEBHOOK",
"HTTP",
"MANAGED",
"HOOKDECK_OUTPOST",
"SANITY",
"BIGCOMMERCE",
"OPENAI",
"POLAR",
"BRIDGE_XYZ",
"BRIDGE_API",
"CHARGEBEE_BILLING",
"CHAINDOTS",
"CLOUDSIGNAL",
"COINBASE",
"COURIER",
"CURSOR",
"MERAKI",
"MICROSOFT_GRAPH",
"MICROSOFT_SHAREPOINT",
"FIREBLOCKS",
"FRONTAPP",
"ZOOM",
"TWITTER",
"RECHARGE",
"RECURLY",
"RING_CENTRAL",
"STRIPE",
"PROPERTY-FINDER",
"QUOTER",
"SHOPIFY",
"TWILIO",
"GITHUB",
"POSTMARK",
"TALLY",
"TYPEFORM",
"PICQER",
"XERO",
"SVIX",
"RESEND",
"ADYEN",
"AKENEO",
"GITLAB",
"WOOCOMMERCE",
"OKTA",
"OURA",
"COMMERCELAYER",
"HUBSPOT",
"MAILGUN",
"PERSONA",
"PIPEDRIVE",
"SENDGRID",
"WORKOS",
"SYNCTERA",
"AWS_SNS",
"THREE_D_EYE",
"TWITCH",
"ENODE",
"FAUNDIT",
"FAVRO",
"LINEAR",
"SHIPHERO",
"SHOPLINE",
"WIX",
"NMI",
"ORB",
"PYLON",
"RAZORPAY",
"REPAY",
"SQUARE",
"SOLIDGATE",
"TRELLO",
"EBAY",
"TELNYX",
"DISCORD",
"TOKENIO",
"FISERV",
"FUSIONAUTH",
"BONDSMITH",
"VERCEL_LOG_DRAINS",
"VERCEL",
"TEBEX",
"SLACK",
"SMARTCAR",
"MAILCHIMP",
"NUVEMSHOP",
"PADDLE",
"PAYPAL",
"PAYSTACK",
"PORTAL",
"TREEZOR",
"PRAXIS",
"CUSTOMERIO",
"EXACT_ONLINE",
"FACEBOOK",
"WHATSAPP",
"REPLICATE",
"TIKTOK",
"TIKTOK_SHOP",
"AIRWALLEX",
"ASCEND",
"ALIPAY",
"ZENDESK",
"UPOLLO",
"SMILE",
"NYLAS",
"CLIO",
"GOCARDLESS",
"LINKEDIN",
"LITHIC",
"STRAVA",
"UTILA",
"MONDAY",
"ZEROHASH",
"ZIFT",
"ETHOCA",
"AIRTABLE",
"ASANA",
"FASTSPRING",
"PAYPRO_GLOBAL",
"USPS",
"FLEXPORT",
"UBER",
"CIRCLE"
]
},
"description": {
"type": "string",
"description": "Description for the source"
},
"config": {
"type": "object",
"description": "The type configs for the specified type"
}
},
"required": [
"name"
]
},
"source_id": {
"type": [
"string",
"null"
],
"description": "ID of a source to bind to the connection"
}
},
"required": [
"PCID"
]
}
hookdeck_connections_upsert_destination
Update or create a destination Parameters:| Parameter | Type | Required | Default | Description | |
|---|---|---|---|---|---|
config | object | No | — | The type configs for the specified type | |
description | string | null | No | — | Description for the destination |
name | string | Yes | — | Name for the destination | |
type | string | No | — | Type of the destination |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"config": {
"type": "object",
"description": "The type configs for the specified type"
},
"description": {
"type": [
"string",
"null"
],
"description": "Description for the destination"
},
"name": {
"type": "string",
"description": "Name for the destination"
},
"type": {
"type": "string",
"description": "Type of the destination",
"enum": [
"HTTP",
"CLI",
"MOCK_API"
]
}
},
"required": [
"PCID",
"name"
]
}
hookdeck_connections_upsert_source
Update or create a source Parameters:| Parameter | Type | Required | Default | Description | |
|---|---|---|---|---|---|
config | object | No | — | The type configs for the specified type | |
description | string | null | No | — | Description for the source |
name | string | Yes | — | A unique name for the source | |
type | string | No | — | Type of the source |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"config": {
"type": "object",
"description": "The type configs for the specified type"
},
"description": {
"type": [
"string",
"null"
],
"description": "Description for the source"
},
"name": {
"type": "string",
"description": "A unique name for the source"
},
"type": {
"type": "string",
"description": "Type of the source",
"enum": [
"AIPRISE",
"ALCHEMY",
"DOCUSIGN",
"INTERCOM",
"PUBLISH_API",
"WEBHOOK",
"HTTP",
"MANAGED",
"HOOKDECK_OUTPOST",
"SANITY",
"BIGCOMMERCE",
"OPENAI",
"POLAR",
"BRIDGE_XYZ",
"BRIDGE_API",
"CHARGEBEE_BILLING",
"CHAINDOTS",
"CLOUDSIGNAL",
"COINBASE",
"COURIER",
"CURSOR",
"MERAKI",
"MICROSOFT_GRAPH",
"MICROSOFT_SHAREPOINT",
"FIREBLOCKS",
"FRONTAPP",
"ZOOM",
"TWITTER",
"RECHARGE",
"RECURLY",
"RING_CENTRAL",
"STRIPE",
"PROPERTY-FINDER",
"QUOTER",
"SHOPIFY",
"TWILIO",
"GITHUB",
"POSTMARK",
"TALLY",
"TYPEFORM",
"PICQER",
"XERO",
"SVIX",
"RESEND",
"ADYEN",
"AKENEO",
"GITLAB",
"WOOCOMMERCE",
"OKTA",
"OURA",
"COMMERCELAYER",
"HUBSPOT",
"MAILGUN",
"PERSONA",
"PIPEDRIVE",
"SENDGRID",
"WORKOS",
"SYNCTERA",
"AWS_SNS",
"THREE_D_EYE",
"TWITCH",
"ENODE",
"FAUNDIT",
"FAVRO",
"LINEAR",
"SHIPHERO",
"SHOPLINE",
"WIX",
"NMI",
"ORB",
"PYLON",
"RAZORPAY",
"REPAY",
"SQUARE",
"SOLIDGATE",
"TRELLO",
"EBAY",
"TELNYX",
"DISCORD",
"TOKENIO",
"FISERV",
"FUSIONAUTH",
"BONDSMITH",
"VERCEL_LOG_DRAINS",
"VERCEL",
"TEBEX",
"SLACK",
"SMARTCAR",
"MAILCHIMP",
"NUVEMSHOP",
"PADDLE",
"PAYPAL",
"PAYSTACK",
"PORTAL",
"TREEZOR",
"PRAXIS",
"CUSTOMERIO",
"EXACT_ONLINE",
"FACEBOOK",
"WHATSAPP",
"REPLICATE",
"TIKTOK",
"TIKTOK_SHOP",
"AIRWALLEX",
"ASCEND",
"ALIPAY",
"ZENDESK",
"UPOLLO",
"SMILE",
"NYLAS",
"CLIO",
"GOCARDLESS",
"LINKEDIN",
"LITHIC",
"STRAVA",
"UTILA",
"MONDAY",
"ZEROHASH",
"ZIFT",
"ETHOCA",
"AIRTABLE",
"ASANA",
"FASTSPRING",
"PAYPRO_GLOBAL",
"USPS",
"FLEXPORT",
"UBER",
"CIRCLE"
]
}
},
"required": [
"PCID",
"name"
]
}

