Building a webhook integration? Read the webhook guide for signatures, retries, event schemas, and troubleshooting.

apiProvider-backed

Create integration credential

POST /api/v1/integrations/credentials

Store a BYOK integration credential for the workspace (bring your own API key/token). Rejects pipedrive, close, and ghl/gohighlevel - those integrations are retired. Auth secrets are masked in the response.

Parameters

workspaceId

string

Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.

service_slugrequired

string

Integration service slug, e.g. ai_ark, crustdata, fullenrich, bettercontact, wiza, signalbase, adyntel, prospeo, instantly, or hubspot.

name

string

Optional display name. Defaults to "<Service> API key".

auth_type

string

Optional. Defaults to the service preset's auth type.

api_key | bearer | basic | oauth2 | custom_header

auth_config

object

Explicit auth config map (e.g. { api_key: "..." }). For Adyntel use { username: "account@email.com", password: "api-key" }. Takes precedence over api_key/bearer_token shorthand.

api_key

string

Shorthand for auth_config when auth_type is api_key.

bearer_token

string

Shorthand for auth_config when auth_type is bearer.

scope

string

Optional. Defaults to the service preset's scope, usually workspace.

personal | workspace

external_id

string

Optional external identifier for the credential (e.g. account id at the provider).

Example

REST requestbash

curl -X POST "https://app.pipeline.help/api/v1/integrations/credentials" \
  -H "Authorization: Bearer $PIPELINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"service_slug":"example"}'

Response

The operation is available, but its typed response schema has not been published yet.

HTTP errors

401: Missing or invalid API key.
403: Authenticated but not permitted for the workspace or resource.
404: The requested resource was not found.