Pipedrive

Use the @bijection/connectors/pipedrive entrypoint to declare Pipedrive resources.

Availability

This page describes the pinned source package. Published availability is unestablished for this artifact. Source build and package availability.

Resources and modes

Resource	Mode	Description
Deals, persons, organizations and activities	`pull`	update_time cursor walk, soft-deletion withdrawal, Basic-authorized webhook hints

Declare a resource in application code, then bind deployment-specific settings and credentials. See typed resources, connections and source inspection.

Deals, persons, organizations and activities

pull: update_time cursor walk, soft-deletion withdrawal, Basic-authorized webhook hints

The following example matches configuration deals.

import { pipedrive } from "@bijection/connectors/pipedrive";
import { makeFunctionReference } from "bijection/server";

export const deals = pipedrive.records.pull({
  object: "deals",
  fields: ["title", "value"],
  updates: "webhooks",
  governingRule: makeFunctionReference<"query", any, [null]>("crm:canUpdate"),
});

Inferred record types

Resource without an operational record table

The function references identify application policy queries. Implement those policies in your application; the references alone grant no authority.

Configuration: deals

Case: pipedrive/records/pull/deals. Connection and resource configuration are declared by this exact case. Credential kind: pipedrive. Keep credential material in the private credential inventory.

Setting	Type	Required	Owner
`companyDomain`	string	Yes	Shared connection

Complete configuration contract

{
  "setup": [],
  "resource": {
    "access": {},
    "defaults": {},
    "connector": "pipedrive",
    "output": {
      "kind": "single",
      "collection": "deals"
    },
    "credential_kind": "pipedrive",
    "connection_fields": [
      "companyDomain"
    ],
    "address": {
      "kind": "setup",
      "field": "companyDomain",
      "prefix": "https://",
      "suffix": ".pipedrive.com/"
    }
  },
  "connection_setup": {
    "type": "object",
    "value": {
      "companyDomain": {
        "fieldType": {
          "type": "string"
        },
        "optional": false
      }
    }
  },
  "execution": null
}

Native admission analysis is available for this exact declaration. Collection: deals

Contract	Meaning
Initial	Enumeration of observed records
Changes	Repeated observations of current records
Deletions	Explicit deletion evidence
Resume	Opaque cursor
Gap	Explicit repair required after a gap
Retention	Unspecified

Complete native profile

{
  "movement": {
    "exchanges": {
      "changes": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "429": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      },
      "deletions": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "429": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      },
      "record": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "404": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "429": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      }
    },
    "nativeInputLimitBytes": null,
    "steps": [
      {
        "id": "acquire.1",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange changes",
          "limitBytes": null
        }
      },
      {
        "id": "acquire.2",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange deletions",
          "limitBytes": null
        }
      },
      {
        "id": "acquire.3",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange record",
          "limitBytes": null
        }
      },
      {
        "id": "acquire.4",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "listener changes",
          "limitBytes": null
        }
      },
      {
        "id": "retain.1",
        "inputs": [
          "acquire.1",
          "acquire.2",
          "acquire.3",
          "acquire.4"
        ],
        "action": {
          "operation": "retain",
          "subject": "acquisition evidence",
          "reason": "recovery",
          "release": "acquisition_custody"
        }
      },
      {
        "id": "interpret.1",
        "inputs": [
          "retain.1"
        ],
        "action": {
          "operation": "interpret",
          "subject": "acquired input",
          "produces": "records"
        }
      },
      {
        "id": "materialize.1",
        "inputs": [
          "interpret.1"
        ],
        "action": {
          "operation": "materialize",
          "subject": "source rows",
          "reason": "serving",
          "release": "replacement"
        }
      },
      {
        "id": "publish.1",
        "inputs": [
          "materialize.1"
        ],
        "action": {
          "operation": "publish",
          "subject": "source rows",
          "visibility": "with_acquisition"
        }
      }
    ]
  },
  "initial": "enumeration",
  "changes": "observations",
  "deletions": "explicit_events",
  "resume": "opaque_cursor",
  "retentionMs": null,
  "gap": "explicit_repair",
  "limits": {
    "http_response_bytes": "524288"
  },
  "restrictions": [],
  "commands": {
    "update": {
      "target": "deals",
      "delivery": "single_attempt",
      "condition": "unconditional",
      "replayWindowMs": null,
      "maxDeliveryHours": "1",
      "providerEnforcedExpiry": false
    }
  }
}

Commands

Command	Target	Condition	Delivery
`update`	deals	Unconditional	Single dispatch attempt

Commands, occurrences and artifacts

{
  "records": {
    "deals": {
      "protocol": "record_observation",
      "coverage": "records",
      "consistency": "observations",
      "atomicity": "record",
      "history": "observations",
      "recordRefresh": true,
      "reconciliation": true,
      "notifications": true,
      "snapshotMaxRows": null,
      "profile": {
        "movement": {
          "exchanges": {
            "changes": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "429": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            },
            "deletions": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "429": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            },
            "record": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "404": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "429": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            }
          },
          "nativeInputLimitBytes": null,
          "steps": [
            {
              "id": "acquire.1",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange changes",
                "limitBytes": null
              }
            },
            {
              "id": "acquire.2",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange deletions",
                "limitBytes": null
              }
            },
            {
              "id": "acquire.3",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange record",
                "limitBytes": null
              }
            },
            {
              "id": "acquire.4",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "listener changes",
                "limitBytes": null
              }
            },
            {
              "id": "retain.1",
              "inputs": [
                "acquire.1",
                "acquire.2",
                "acquire.3",
                "acquire.4"
              ],
              "action": {
                "operation": "retain",
                "subject": "acquisition evidence",
                "reason": "recovery",
                "release": "acquisition_custody"
              }
            },
            {
              "id": "interpret.1",
              "inputs": [
                "retain.1"
              ],
              "action": {
                "operation": "interpret",
                "subject": "acquired input",
                "produces": "records"
              }
            },
            {
              "id": "materialize.1",
              "inputs": [
                "interpret.1"
              ],
              "action": {
                "operation": "materialize",
                "subject": "source rows",
                "reason": "serving",
                "release": "replacement"
              }
            },
            {
              "id": "publish.1",
              "inputs": [
                "materialize.1"
              ],
              "action": {
                "operation": "publish",
                "subject": "source rows",
                "visibility": "with_acquisition"
              }
            }
          ]
        },
        "initial": "enumeration",
        "changes": "observations",
        "deletions": "explicit_events",
        "resume": "opaque_cursor",
        "retentionMs": null,
        "gap": "explicit_repair",
        "limits": {
          "http_response_bytes": "524288"
        },
        "restrictions": [],
        "commands": {
          "update": {
            "target": "deals",
            "delivery": "single_attempt",
            "condition": "unconditional",
            "replayWindowMs": null,
            "maxDeliveryHours": "1",
            "providerEnforcedExpiry": false
          }
        }
      }
    }
  },
  "occurrences": null,
  "artifacts": {
    "raw_archive": false,
    "native_file_transfer_limit_bytes": null,
    "external_versions": false,
    "files": {}
  },
  "commands": {
    "update": {
      "target": "deals",
      "condition": {
        "kind": "unconditional"
      },
      "delivery": {
        "kind": "single_attempt",
        "retention": {
          "kind": "unknown"
        },
        "max_delivery_hours": 1
      }
    }
  }
}

Recorded checks

Requirement	Scope	Evidence	Result
listener-custody-before-ack	{“kind”:“listener”,“collection”:“deals”}	Native test: integrations/listeners/webhook_delivery_commits_responsibility_before_acknowledging (shared_engine)	Execution result unavailable
listener-duplicate-delivery	{“kind”:“listener”,“collection”:“deals”}	Native test: integrations/providers/shopify_product_hint_is_deduplicated_and_refused_when_unsigned (shared_engine)	Execution result unavailable
page-publication-recovery	{“kind”:“collection”,“name”:“deals”}	Native test: integrations/acquisition/acquisition_windows_preserve_sequences_and_restart_fences_old_work (shared_engine)	Execution result unavailable
stated-cursor-empty-page-advances	{“kind”:“collection”,“name”:“deals”}	Fixture: ./src/connectors/pipedrive/fixtures/empty-page-advances-deals.json	passed (2026-10-24T21:36:12.292Z)
stated-cursor-repeat-refused	{“kind”:“collection”,“name”:“deals”}	No check exercises this packaged Pipedrive declaration against Pipedrive; only package fixtures of the declaration ran, and nothing has been qualified.	Execution result unavailable
command-response-lost	{“kind”:“command”,“name”:“update”}	Native test: integrations/listeners/calendar_repair_preserves_accepted_responsibility (shared_engine)	Execution result unavailable
backoff-stated-wait	{“kind”:“connection”}	Native test: integrations/acquisition/backoff_a_stated_wait_defers_the_next_dispatch_and_then_resumes (shared_engine)	Execution result unavailable
identity-account	{“kind”:“connection”}	Fixture: ./src/connectors/pipedrive/fixtures/identity.json	passed (2026-10-24T21:36:12.292Z)

Hosted qualification: unestablished for this catalog configuration. Installed connections report their own identity, authority and current status.

Configuration: persons

Case: pipedrive/records/pull/persons. Connection and resource configuration are declared by this exact case. Credential kind: pipedrive. Keep credential material in the private credential inventory.

Setting	Type	Required	Owner
`companyDomain`	string	Yes	Shared connection

Complete configuration contract

{
  "setup": [],
  "resource": {
    "access": {},
    "defaults": {},
    "connector": "pipedrive",
    "output": {
      "kind": "single",
      "collection": "persons"
    },
    "credential_kind": "pipedrive",
    "connection_fields": [
      "companyDomain"
    ],
    "address": {
      "kind": "setup",
      "field": "companyDomain",
      "prefix": "https://",
      "suffix": ".pipedrive.com/"
    }
  },
  "connection_setup": {
    "type": "object",
    "value": {
      "companyDomain": {
        "fieldType": {
          "type": "string"
        },
        "optional": false
      }
    }
  },
  "execution": null
}

Native admission analysis is available for this exact declaration. Collection: persons

Contract	Meaning
Initial	Enumeration of observed records
Changes	Repeated observations of current records
Deletions	Explicit deletion evidence
Resume	Opaque cursor
Gap	Explicit repair required after a gap
Retention	Unspecified

Complete native profile

{
  "movement": {
    "exchanges": {
      "changes": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "429": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      },
      "record": {
        "200": {
          "placement": "retained_bytes",
          "interpretation": "json",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "404": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        },
        "429": {
          "placement": "retained_bytes",
          "interpretation": "opaque",
          "projectsBeforeRetention": false,
          "retainedBodyLimitBytes": "524288",
          "fileLimitBytes": null
        }
      }
    },
    "nativeInputLimitBytes": null,
    "steps": [
      {
        "id": "acquire.1",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange changes",
          "limitBytes": null
        }
      },
      {
        "id": "acquire.2",
        "inputs": [],
        "action": {
          "operation": "acquire",
          "subject": "exchange record",
          "limitBytes": null
        }
      },
      {
        "id": "retain.1",
        "inputs": [
          "acquire.1",
          "acquire.2"
        ],
        "action": {
          "operation": "retain",
          "subject": "acquisition evidence",
          "reason": "recovery",
          "release": "acquisition_custody"
        }
      },
      {
        "id": "interpret.1",
        "inputs": [
          "retain.1"
        ],
        "action": {
          "operation": "interpret",
          "subject": "acquired input",
          "produces": "records"
        }
      },
      {
        "id": "materialize.1",
        "inputs": [
          "interpret.1"
        ],
        "action": {
          "operation": "materialize",
          "subject": "source rows",
          "reason": "serving",
          "release": "replacement"
        }
      },
      {
        "id": "publish.1",
        "inputs": [
          "materialize.1"
        ],
        "action": {
          "operation": "publish",
          "subject": "source rows",
          "visibility": "with_acquisition"
        }
      }
    ]
  },
  "initial": "enumeration",
  "changes": "observations",
  "deletions": "explicit_events",
  "resume": "opaque_cursor",
  "retentionMs": null,
  "gap": "explicit_repair",
  "limits": {
    "http_response_bytes": "524288"
  },
  "restrictions": [],
  "commands": {}
}

Commands, occurrences and artifacts

{
  "records": {
    "persons": {
      "protocol": "record_observation",
      "coverage": "records",
      "consistency": "observations",
      "atomicity": "record",
      "history": "observations",
      "recordRefresh": true,
      "reconciliation": true,
      "notifications": false,
      "snapshotMaxRows": null,
      "profile": {
        "movement": {
          "exchanges": {
            "changes": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "429": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            },
            "record": {
              "200": {
                "placement": "retained_bytes",
                "interpretation": "json",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "404": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              },
              "429": {
                "placement": "retained_bytes",
                "interpretation": "opaque",
                "projectsBeforeRetention": false,
                "retainedBodyLimitBytes": "524288",
                "fileLimitBytes": null
              }
            }
          },
          "nativeInputLimitBytes": null,
          "steps": [
            {
              "id": "acquire.1",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange changes",
                "limitBytes": null
              }
            },
            {
              "id": "acquire.2",
              "inputs": [],
              "action": {
                "operation": "acquire",
                "subject": "exchange record",
                "limitBytes": null
              }
            },
            {
              "id": "retain.1",
              "inputs": [
                "acquire.1",
                "acquire.2"
              ],
              "action": {
                "operation": "retain",
                "subject": "acquisition evidence",
                "reason": "recovery",
                "release": "acquisition_custody"
              }
            },
            {
              "id": "interpret.1",
              "inputs": [
                "retain.1"
              ],
              "action": {
                "operation": "interpret",
                "subject": "acquired input",
                "produces": "records"
              }
            },
            {
              "id": "materialize.1",
              "inputs": [
                "interpret.1"
              ],
              "action": {
                "operation": "materialize",
                "subject": "source rows",
                "reason": "serving",
                "release": "replacement"
              }
            },
            {
              "id": "publish.1",
              "inputs": [
                "materialize.1"
              ],
              "action": {
                "operation": "publish",
                "subject": "source rows",
                "visibility": "with_acquisition"
              }
            }
          ]
        },
        "initial": "enumeration",
        "changes": "observations",
        "deletions": "explicit_events",
        "resume": "opaque_cursor",
        "retentionMs": null,
        "gap": "explicit_repair",
        "limits": {
          "http_response_bytes": "524288"
        },
        "restrictions": [],
        "commands": {}
      }
    }
  },
  "occurrences": null,
  "artifacts": {
    "raw_archive": false,
    "native_file_transfer_limit_bytes": null,
    "external_versions": false,
    "files": {}
  },
  "commands": {}
}

Recorded checks

Requirement	Scope	Evidence	Result
page-publication-recovery	{“kind”:“collection”,“name”:“persons”}	Native test: integrations/acquisition/acquisition_windows_preserve_sequences_and_restart_fences_old_work (shared_engine)	Execution result unavailable
stated-cursor-empty-page-advances	{“kind”:“collection”,“name”:“persons”}	Fixture: ./src/connectors/pipedrive/fixtures/empty-page-advances.json	passed (2026-10-24T21:36:12.293Z)
stated-cursor-repeat-refused	{“kind”:“collection”,“name”:“persons”}	No check exercises this packaged Pipedrive declaration against Pipedrive; only package fixtures of the declaration ran, and nothing has been qualified.	Execution result unavailable
backoff-stated-wait	{“kind”:“connection”}	Native test: integrations/acquisition/backoff_a_stated_wait_defers_the_next_dispatch_and_then_resumes (shared_engine)	Execution result unavailable
identity-account	{“kind”:“connection”}	Fixture: ./src/connectors/pipedrive/fixtures/identity.json	passed (2026-10-24T21:36:12.293Z)

Hosted qualification: unestablished for this catalog configuration. Installed connections report their own identity, authority and current status.

Provider guidance

Compiled declaration examples and configuration details are published in the connector reference. The connection holds a pipedrive credential (pipedrive.credential) for https://<companyDomain>.pipedrive.com, with companyDomain as setup. An API token is a header API-key credential named x-api-token; an OAuth token is a bearer. Identity is the exact integer company_id of GET /api/v1/users/me. records.pull reads one of deals, persons, organizations or activities through API v2: updated_since (inclusive) sorted by update_time ascending, 500 rows a page by next_cursor. The first pass starts at 1970; each finished pass carries the latest update_time it read and the next pass starts five minutes before it, deduplicating re-read rows by update_time, the version. is_deleted: true withdraws a record. Deals list deleted rows only under status=deleted (for 30 days), so a deal pass ends with that listing from the same bound. Whether the other listings return soft-deleted rows is not documented. Fields are kept as provider text, so money never passes through a float. With updates: "webhooks", a webhooks v2 delivery identified by meta.id hints that the object type changed, and the next pass reads it. Pipedrive signs nothing; it sends the HTTP Basic credentials configured on the webhook, which the listener’s signing credential holds as the whole Authorization value, so a delivery proves the channel, not its body: it cannot name the record to refresh. update is an unconditional single-attempt PATCH. Nothing here has run against Pipedrive or been qualified.

Provider references

Provider references and prerequisites are maintained in the connector guidance above. No separate provider-documentation review date is recorded.

Source and evidence

Canonical connector source, native analysis and check receipts. Connector artifact: 905888ea276a2a28e36981a79e8142b2547ea451c3e63162cb6915ad4a7d1305. The resource declaration examples above are compiled and compared with exact catalog declarations. Recorded checks apply only to their source, declaration and runtime identities. Configure a connection and inspect its status to establish deployment-specific readiness.

Get Started

Use-case atlas

Platform

Data and Operations

Guides

Client Libraries

Tools

API Reference

Availability

Resources and modes

Deals, persons, organizations and activities

pull: update_time cursor walk, soft-deletion withdrawal, Basic-authorized webhook hints

Configuration: deals

Configuration: persons

Provider guidance

Provider references

Source and evidence

​Availability

​Resources and modes

​Deals, persons, organizations and activities

​pull: update_time cursor walk, soft-deletion withdrawal, Basic-authorized webhook hints

​Configuration: deals

​Configuration: persons

​Provider guidance

​Provider references

​Source and evidence

Availability

Resources and modes

Deals, persons, organizations and activities

pull: update_time cursor walk, soft-deletion withdrawal, Basic-authorized webhook hints

Configuration: deals

Configuration: persons

Provider guidance

Provider references

Source and evidence