Your CRM.
Connected by Weave.

Bring customer details into Weave, hand off a referral, and keep both companies’ systems in the loop.

Explore the API Download API specification

Build your connection.

Each connection belongs to a company or one of its referral partners. Its imported customer list stays private to that connection. When a partner sends a referral, Weave shares the selected customer’s details with the receiving company.

An administrator creates a connection and issues a key with the scopes the integration needs.
Your integration imports customers from the source CRM. A sender selects a customer and confirms permission to share their details.
The receiving integration reads the referral, creates its CRM record, and sends the record ID and progress back to Weave.

Developer preview. This reference covers the implemented API contract. Access must be enabled for your environment and account, with a paid API entitlement. Native GSRM, ServiceTitan, Housecall Pro, and Albi connectors and self-service setup screens are in development. Provider names in the API identify a connection; they do not activate a native connector.

One connection. Scoped access.

Send your connection’s API key as a bearer token. Keep it on your server. Keys are shown once, can be revoked, and have explicit scopes such as customers:read, customers:write, and referrals:write.

GET /api/v1/connections/{connectionId}/customers
Authorization: Bearer YOUR_WEAVE_API_KEY
Accept: application/json

Connection and key administration requires an authorized Weave session. Session-based writes also require a matching Origin header. A company administrator cannot use their own access to browse a partner’s private customer list. Partner administrators control whether their team can access imported customers.

Request fields use camelCase. Returned database records use snake_case. Successful responses wrap records in data; paginated lists also return nextCursor. Use the full paths shown below on your Weave environment’s host.

From customer to referral.

Import the contact and service address with the CRM’s stable customer ID and its last update time. Keep unit or suite numbers separate. Optional company name and contact preferences help the receiving team follow up.

POST /api/v1/connections/{connectionId}/customers
Authorization: Bearer YOUR_WEAVE_API_KEY
Content-Type: application/json

{
  "externalId": "customer-123",
  "name": "Pat Homeowner",
  "firstName": "Pat",
  "lastName": "Homeowner",
  "phone": "4255550123",
  "email": "pat@example.com",
  "address": {
    "line1": "123 Main St",
    "line2": "Unit 4",
    "city": "Monroe",
    "state": "WA",
    "postalCode": "98272"
  },
  "sourceUpdatedAt": "2026-10-06T12:00:00Z"
}

Use the returned Weave customer ID to submit the referral. Include the service need, urgency, and explicit consent to contact. Weave supplies the referral source company and referral contact from its membership records.

POST /api/v1/connections/{connectionId}/customers/{customerId}/referrals
Authorization: Bearer YOUR_WEAVE_API_KEY
Content-Type: application/json
Idempotency-Key: referral-customer-123-water-001

{
  "lossType": "water",
  "description": "Burst supply line under the kitchen sink.",
  "isEmergency": true,
  "consentToContact": true
}

For a partner integration acting on a person’s behalf, include submittedByMemberId to identify the sending partner member. Weave verifies the membership. Without it, an API-key submission has company attribution but no individual referral contact. Session-based submissions use the signed-in member.

The receiving integration reads the referral, writes a customer, lead, or job to its CRM, then acknowledges that record with PUT /api/v1/connections/{connectionId}/referrals/{referralId}/crm-link. For example, send {"recordType":"job","externalId":"job-456"}. Only the receiving company can advance referral status. Status updates record progress; they do not execute payments.

A referral preserves the details shared at submission. Later customer imports do not silently rewrite it. CRM record IDs remain private to the connection that supplied them.

A better address, confirmed.

Use Google-powered autocomplete and address validation through your authenticated Weave connection. Both endpoints require customers:read and currently support US addresses. Show the returned Google Maps attribution alongside suggestions and results.

POST /api/v1/connections/{connectionId}/addresses/autocomplete
{
  "input": "1600 Amphitheatre",
  "sessionToken": "47c01763-bf66-47d8-bfb7-7120a9582381"
}

POST /api/v1/connections/{connectionId}/addresses/validate
{
  "address": {
    "line1": "1600 Amphitheatre Parkway",
    "city": "Mountain View",
    "state": "CA",
    "postalCode": "94043"
  },
  "sessionToken": "47c01763-bf66-47d8-bfb7-7120a9582381"
}

Create a fresh session token when address editing starts. Reuse it for suggestions and the first validation request, which ends the autocomplete session. If the sender edits the result, validate again without that token and include the first validation’s responseId as previousResponseId.

The response includes originalAddress, suggestedAddress, and an assessment of confirm or fix. Always have the sender confirm the address, including any unit or suite. Unresolved or missing details require a correction. If lookup is unavailable, allow manual entry.

After confirmation, pass confirmedAddress when referring an imported customer. It changes the address on that referral’s snapshot and leaves the source customer record intact. Keep Google keys on the server.

Keep both sides informed.

Register an HTTPS endpoint for the events your integration needs. Notifications contain identifiers; fetch the current authorized record for customer details and the latest status.

POST /api/v1/connections/{connectionId}/webhooks
Authorization: Bearer YOUR_WEAVE_API_KEY
Content-Type: application/json

{
  "url": "https://your-app.example.com/webhooks/weave",
  "events": ["referral.created", "referral.status_changed"]
}

Verify X-Weave-Signature before processing the exact raw request body. Its format is t=timestamp,v1=signature. Compute HMAC-SHA256 with the connection’s outbound secret over timestamp + "." + rawBody, compare securely, and reject timestamps more than five minutes from your clock.

Durably accept the event before returning a 2xx response. Deduplicate by the body’s id or X-Weave-Event-Id. Delivery is at least once and events can arrive out of order.

To send CRM changes into Weave, post a normalized event to /api/webhooks/crm/{connectionId} and sign it with the separate inbound secret. This endpoint accepts the Weave event schema, not a provider’s raw webhook format. Your connector translates the CRM payload first. Rotating secrets invalidates both old secrets immediately.

Build for the second attempt.

Referral retries: reuse the same Idempotency-Key and request body. Reusing a key with changed content returns 409.
Customer versions: send sourceUpdatedAt. Older or equal versions are ignored, and deletion tombstones stop stale imports from restoring removed customers.
Event recovery: poll the events feed using its cursor. Webhooks make up to eight delivery attempts; inspect deliveries and explicitly retry exhausted items.
Limits: JSON bodies are limited to 64 KiB. Requests are limited to 120 per minute per caller and connection; Google address requests also share a 120-per-minute connection limit. Honor Retry-After on 429 responses.
Errors: 401 means missing or invalid authentication, 402 means a paid API entitlement is required, 403 means access is denied, and 422 means invalid input. Responses include an error code, message, and request ID.

Every endpoint, in one place.

Search the implemented API and expand an endpoint for its access requirements and request schema. The downloadable OpenAPI contract includes parameters and response schemas.

Find an endpoint

29 endpoints

GET/api/v1/capabilitiesDiscover implemented features and connector status

Public reference; no API key required.

Your CRM.Connected by Weave.

Build your connection.

One connection. Scoped access.

From customer to referral.

A better address, confirmed.

Keep both sides informed.

Build for the second attempt.

Every endpoint, in one place.

JSON request schema

JSON request schema

JSON request schema

JSON request schema

JSON request schema

JSON request schema

JSON request schema

JSON request schema

JSON request schema

JSON request schema

JSON request schema

JSON request schema

JSON request schema

Your CRM.
Connected by Weave.