Hello...
" } ``` -------------------------------- ### API Error Response Examples Source: https://seedlycrm.com/docs/help/api Standard JSON error structures returned by the API for various failure scenarios. ```json { "error": { "code": "UNAUTHORIZED", "message": "Missing or invalid API key. Provide a valid key in the Authorization header: Bearer sk_live_..." } } ``` ```json { "error": { "code": "VALIDATION_ERROR", "message": "firstName and lastName are required" } } ``` ```json { "error": { "code": "FORBIDDEN", "message": "API key missing required scope: contacts:write. Update key permissions in Settings > Integrations > API Keys." } } ``` ```json { "error": { "code": "RATE_LIMITED", "message": "Rate limit exceeded. Retry after the period indicated in the Retry-After header." } } ``` -------------------------------- ### Get Contact Endpoint Source: https://seedlycrm.com/docs/help/api Retrieves a single contact by its unique identifier. ```http GET /api/v1/contacts/{id} ``` -------------------------------- ### GET /api/v1/conversations Source: https://seedlycrm.com/docs/help/api Retrieves a list of conversations based on optional filters. ```APIDOC ## GET /api/v1/conversations ### Description List conversations with optional filtering by status, channel, contact, or assignee. ### Method GET ### Endpoint /api/v1/conversations ### Parameters #### Query Parameters - **status** (string) - Optional - open, closed, snoozed - **channel** (string) - Optional - Filter by channel type - **contactId** (string) - Optional - Filter by contact ID - **assignedTo** (string) - Optional - Filter by team member ID - **limit** (number) - Optional - Max results (default 50, max 200) ``` -------------------------------- ### GET /api/v1/contacts/fields Source: https://seedlycrm.com/docs/help/api Retrieves the list of custom field definitions configured for the sub-account. ```APIDOC ## GET /api/v1/contacts/fields ### Description Returns the list of custom field definitions configured for the sub-account. ### Method GET ### Endpoint /api/v1/contacts/fields ### Response #### Success Response (200) - **data** (array) - List of custom field definitions ``` -------------------------------- ### Get Custom Field Definitions Endpoint Source: https://seedlycrm.com/docs/help/api Retrieves the list of custom field definitions configured for the sub-account. ```http GET /api/v1/contacts/fields ``` -------------------------------- ### GET /api/v1/calendars/availability Source: https://seedlycrm.com/docs/help/api Checks availability for a specific appointment type on a given date. ```APIDOC ## GET /api/v1/calendars/availability ### Description Checks availability for a specific appointment type on a given date. ### Method GET ### Endpoint /api/v1/calendars/availability ### Parameters #### Query Parameters - **appointmentTypeId** (string) - Required - The ID of the appointment type - **date** (string) - Required - Date in YYYY-MM-DD format ### Response #### Success Response (200) - **data** (array) - List of available time slots #### Response Example { "data": [ { "start": "2026-04-01T09:00:00-04:00", "end": "2026-04-01T09:30:00-04:00" }, { "start": "2026-04-01T09:30:00-04:00", "end": "2026-04-01T10:00:00-04:00", "seatsRemaining": 3 } ] } ``` -------------------------------- ### GET /api/v1/contacts/{id} Source: https://seedlycrm.com/docs/help/api Retrieve details for a specific contact by their unique identifier. ```APIDOC ## GET /api/v1/contacts/{id} ### Description Retrieve details for a specific contact by their unique identifier. ### Method GET ### Endpoint /api/v1/contacts/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the contact ``` -------------------------------- ### GET /api/v1/calendars/types Source: https://seedlycrm.com/docs/help/api Lists all available appointment types, with an optional filter by calendar ID. ```APIDOC ## GET /api/v1/calendars/types ### Description Lists all available appointment types. ### Method GET ### Endpoint /api/v1/calendars/types ### Parameters #### Query Parameters - **calendarId** (string) - Optional - Filter by a specific calendar ### Response #### Success Response (200) - **data** (array) - List of appointment types #### Response Example { "data": [ { "id": "apt_type_001", "calendarId": "cal_abc123", "name": "30-Minute Consultation", "duration": 30, "slug": "30-min-consultation" } ] } ``` -------------------------------- ### Update Conversation Request Body Source: https://seedlycrm.com/docs/help/api Example JSON payload for updating conversation fields. ```json { "status": "closed", "assignedTo": "user_id_here" } ``` -------------------------------- ### Update Contact Request Body Source: https://seedlycrm.com/docs/help/api Example JSON payload for updating specific fields of a contact. ```json { "lifecycleStage": "customer", "tags": ["vip", "enterprise"] } ``` -------------------------------- ### Get Conversation Endpoint Source: https://seedlycrm.com/docs/help/api Endpoint for retrieving details of a specific conversation by ID. ```http GET /api/v1/conversations/{id} ``` -------------------------------- ### GET /api/v1/contacts Source: https://seedlycrm.com/docs/help/api Retrieves a list of contacts based on optional filters and pagination parameters. ```APIDOC ## GET /api/v1/contacts ### Description Retrieves a list of contacts. Supports filtering by search terms, email, lifecycle stage, source, tags, assigned team member, and phone presence. ### Method GET ### Endpoint /api/v1/contacts ### Parameters #### Query Parameters - **search** (string) - Optional - Full-text search (name, email, company) - **email** (string) - Optional - Exact email match - **limit** (number) - Optional - Max results (default 50, max 100) - **cursor** (string) - Optional - Pagination cursor - **lifecycleStage** (string) - Optional - Filter by stage - **source** (string) - Optional - Filter by lead source - **tags** (string) - Optional - Comma-separated tag filter - **assignedTo** (string) - Optional - Filter by team member ID - **hasPhone** (boolean) - Optional - true to only return contacts with phone numbers ### Response #### Success Response (200) - **data** (array) - List of contact objects - **meta** (object) - Pagination metadata ``` -------------------------------- ### GET /api/v1/contacts Source: https://seedlycrm.com/docs/help/api List or search contacts. Supports an optional email query parameter for exact matching. ```APIDOC ## GET /api/v1/contacts ### Description List or search contacts. Supports an optional email query parameter for exact matching. ### Method GET ### Endpoint /api/v1/contacts ### Parameters #### Query Parameters - **email** (string) - Optional - Exact match filter for contact email ``` -------------------------------- ### GET /api/v1/sub-accounts Source: https://seedlycrm.com/docs/help/api Retrieves a list of all sub-accounts accessible to an agency-scoped API key. This is required for agency-level integrations to map sub-account IDs for subsequent API calls. ```APIDOC ## GET /api/v1/sub-accounts ### Description Lists all sub-accounts available to the agency-scoped API key. ### Method GET ### Endpoint /api/v1/sub-accounts ### Response #### Success Response (200) - **data** (array) - List of sub-account objects containing id and name. #### Response Example { "data": [ { "id": "sub_abc123", "name": "Acme Corp" }, { "id": "sub_def456", "name": "Widget Co" } ] } ``` -------------------------------- ### Preview and Apply SeedlyCRM Updates Source: https://seedlycrm.com/docs/help/updating Commands to preview update changes using a dry run and to apply the update to the project. ```bash npx pnpm run update -- --dry-run --from path/to/new-version ``` ```bash npx pnpm run update -- --from path/to/new-version ``` -------------------------------- ### Exporting Convex data via CLI Source: https://seedlycrm.com/docs/help/backups Use this command to create a portable snapshot of your data and file storage for off-platform backup. ```bash npx convex export --path seedly-backup.zip --include-file-storage ``` -------------------------------- ### Restore backup using Convex CLI Source: https://seedlycrm.com/docs/help/backups Use this command to import a backup zip file into a deployment. Ensure this is performed in a non-production environment for testing purposes. ```bash npx convex import --path seedly-backup.zip ``` -------------------------------- ### task.created Source: https://seedlycrm.com/docs/help/webhooks Fires when a new task is created. ```APIDOC ## task.created ### Description Fires when a new task is created. ### Payload Example { "event": "task.created", "timestamp": "2026-03-27T14:52:00.000Z", "data": { "subAccountId": "sa_001", "contactId": "abc123", "taskId": "task001", "title": "Follow up with Jane", "status": "todo", "priority": "high", "dueDate": 1743595200000, "assignedTo": "user001" } } ``` -------------------------------- ### Implement Cursor-Based Pagination Source: https://seedlycrm.com/docs/help/api Fetch paginated results by passing the cursor from the previous response's meta object. Continue requests until hasMore is false. ```http GET /api/v1/contacts?limit=50 Authorization: Bearer sk_live_... ``` ```json { "data": [ /* first 50 contacts */ ], "meta": { "total": 150, "hasMore": true, "cursor": "eyJpZCI6ImNvbnRhY3RfMDUwIn0" } } ``` ```http GET /api/v1/contacts?limit=50&cursor=eyJpZCI6ImNvbnRhY3RfMDUwIn0 Authorization: Bearer sk_live_... ``` ```json { "data": [ /* next 50 contacts */ ], "meta": { "total": 150, "hasMore": true, "cursor": "eyJpZCI6ImNvbnRhY3RfMTAwIn0" } } ``` ```json { "data": [ /* final 50 contacts */ ], "meta": { "total": 150, "hasMore": false, "cursor": null } } ``` -------------------------------- ### POST /api/v1/webhooks Source: https://seedlycrm.com/docs/help/api Creates a new webhook subscription. ```APIDOC ## POST /api/v1/webhooks ### Description Creates a new webhook subscription. Returns the subscription details including a signing secret. ### Method POST ### Endpoint /api/v1/webhooks ### Request Body - **url** (string) - Required - The URL to receive webhook events - **events** (array) - Required - List of event names to subscribe to - **description** (string) - Optional - Description of the integration ``` -------------------------------- ### appointment.booked Source: https://seedlycrm.com/docs/help/webhooks Fires when a new appointment is booked. ```APIDOC ## appointment.booked ### Description Fires when a new appointment is booked. ### Payload - **event** (string) - The event name: "appointment.booked" - **timestamp** (string) - ISO 8601 timestamp of the event - **data** (object) - Event details - **subAccountId** (string) - ID of the sub-account - **contactId** (string) - Unique ID of the contact - **appointmentId** (string) - Unique ID of the appointment - **calendarId** (string) - Unique ID of the calendar - **appointmentTypeId** (string) - Unique ID of the appointment type - **appointmentTitle** (string) - Title of the appointment - **startTime** (number) - Start time in milliseconds - **endTime** (number) - End time in milliseconds - **status** (string) - Status of the appointment ### Example { "event": "appointment.booked", "timestamp": "2026-03-27T14:38:00.000Z", "data": { "subAccountId": "sa_001", "contactId": "abc123", "appointmentId": "appt001", "calendarId": "cal001", "appointmentTypeId": "type001", "appointmentTitle": "30-Min Consultation", "startTime": 1743508800000, "endTime": 1743510600000, "status": "scheduled" } } ``` -------------------------------- ### Create Contact Endpoint Source: https://seedlycrm.com/docs/help/api Creates a new contact record. ```http POST /api/v1/contacts ``` -------------------------------- ### opportunity.created Source: https://seedlycrm.com/docs/help/webhooks Fires when a new opportunity is created in a pipeline. ```APIDOC ## opportunity.created ### Description Fires when a new opportunity is created in a pipeline. ### Response Example { "event": "opportunity.created", "timestamp": "2026-03-27T14:39:00.000Z", "data": { "subAccountId": "sa_001", "contactId": "abc123", "opportunityId": "opp001", "pipelineId": "pipe001", "stageId": "stage001", "title": "Website Redesign", "value": 5000 } } ``` -------------------------------- ### GET /api/v1/contacts/{id} Source: https://seedlycrm.com/docs/help/api Retrieves a single contact record by its unique identifier. ```APIDOC ## GET /api/v1/contacts/{id} ### Description Retrieves the full details of a specific contact. ### Method GET ### Endpoint /api/v1/contacts/{id} ### Parameters #### Path Parameters - **id** (string) - Required - Unique identifier of the contact ``` -------------------------------- ### GET /api/v1/conversations/{id}/messages Source: https://seedlycrm.com/docs/help/api Lists messages within a specific conversation. ```APIDOC ## GET /api/v1/conversations/{id}/messages ### Description Fetch a list of messages for a given conversation. ### Method GET ### Endpoint /api/v1/conversations/{id}/messages ### Parameters #### Path Parameters - **id** (string) - Required - The conversation ID #### Query Parameters - **limit** (number) - Optional - Max results (default 50, max 100) - **cursor** (string) - Optional - Pagination cursor ``` -------------------------------- ### List Webhook Subscriptions Source: https://seedlycrm.com/docs/help/api Retrieve all configured webhook subscriptions. ```http GET /api/v1/webhooks ``` -------------------------------- ### contact.created Source: https://seedlycrm.com/docs/help/webhooks Fires when a new contact is created. ```APIDOC ## contact.created ### Description Fires when a new contact is created. ### Payload Example { "event": "contact.created", "timestamp": "2026-03-27T14:30:00.000Z", "data": { "subAccountId": "sa_001", "contactId": "abc123", "firstName": "Jane", "lastName": "Doe", "email": "jane@example.com", "phone": "+15551234567", "company": "Acme Corp", "source": "api", "tags": ["website-lead"], "lifecycleStage": "lead" } } ``` -------------------------------- ### POST /api/v1/calendars/appointments Source: https://seedlycrm.com/docs/help/api Books a new appointment. ```APIDOC ## POST /api/v1/calendars/appointments ### Description Books a new appointment. ### Method POST ### Endpoint /api/v1/calendars/appointments ### Parameters #### Request Body - **appointmentTypeId** (string) - Required - Type of appointment to book - **startTime** (integer) - Required - Start time (Unix timestamp, milliseconds) - **endTime** (integer) - Required - End time (Unix timestamp, milliseconds) - **firstName** (string) - Required - Booker's first name - **lastName** (string) - Required - Booker's last name - **email** (string) - Required - Booker's email - **phone** (string) - Optional - Booker's phone - **notes** (string) - Optional - Additional notes ### Request Example { "appointmentTypeId": "...", "startTime": 1743508800000, "endTime": 1743510600000, "firstName": "Jane", "lastName": "Doe", "email": "jane@example.com", "phone": "+15551234567", "notes": "First consultation" } ``` -------------------------------- ### task.completed Source: https://seedlycrm.com/docs/help/webhooks Fires when a task is marked completed. ```APIDOC ## task.completed ### Description Fires when a task is marked completed. ### Payload Example { "event": "task.completed", "timestamp": "2026-03-27T14:54:00.000Z", "data": { "subAccountId": "sa_001", "contactId": "abc123", "taskId": "task001", "title": "Follow up with Jane", "status": "completed", "priority": "high", "completedAt": 1743596400000 } } ``` -------------------------------- ### GET /api/v1/conversations Source: https://seedlycrm.com/docs/help/api List conversations. Supports an optional contactId query parameter for filtering. ```APIDOC ## GET /api/v1/conversations ### Description List conversations. Supports an optional contactId query parameter for filtering. ### Method GET ### Endpoint /api/v1/conversations ### Parameters #### Query Parameters - **contactId** (string) - Optional - Filter conversations by contact ID ``` -------------------------------- ### Create Webhook Subscription Source: https://seedlycrm.com/docs/help/api Register a new webhook endpoint to receive specific events. ```http POST /api/v1/webhooks ``` ```json { "url": "https://your-server.com/webhooks/seedly", "events": [ "contact.created", "message.received", "message.sent", "message.delivered", "message.failed", "appointment.booked" ], "description": "Chatbot integration" } ``` -------------------------------- ### Book Appointment Source: https://seedlycrm.com/docs/help/api Creates a new appointment. Requires the calendars:write scope. ```http POST /api/v1/calendars/appointments ``` ```json { "appointmentTypeId": "...", "startTime": 1743508800000, "endTime": 1743510600000, "firstName": "Jane", "lastName": "Doe", "email": "jane@example.com", "phone": "+15551234567", "notes": "First consultation" } ``` -------------------------------- ### POST /webhooks/event/{slug} Source: https://seedlycrm.com/docs/help/api Injects custom events into running workflows that are waiting at 'goal' nodes. ```APIDOC ## POST /webhooks/event/{slug} ### Description Injects a custom event into a running workflow that is currently waiting at a 'goal' node. ### Method POST ### Endpoint https://{YOUR_DEPLOYMENT_URL}/webhooks/event/{slug} ### Parameters #### Path Parameters - **slug** (string) - Required - The unique identifier for the workflow. #### Request Body - **eventType** (string) - Required - The type of event being injected. - **contactId** (string) - Optional - The contact ID associated with the event. - **data** (object) - Optional - Data payload for the event. ``` -------------------------------- ### appointment.confirmed Source: https://seedlycrm.com/docs/help/webhooks Fires when an appointment is confirmed. ```APIDOC ## appointment.confirmed ### Description Fires when an appointment is confirmed. ### Payload - **event** (string) - The event name: appointment.confirmed - **timestamp** (string) - ISO 8601 timestamp of the event - **data** (object) - Contains subAccountId, contactId, appointmentId, and status ``` -------------------------------- ### appointment.completed Source: https://seedlycrm.com/docs/help/webhooks Fires when an appointment is marked completed. ```APIDOC ## appointment.completed ### Description Fires when an appointment is marked completed. ### Payload - **event** (string) - The event name: appointment.completed - **timestamp** (string) - ISO 8601 timestamp of the event - **data** (object) - Contains subAccountId, contactId, appointmentId, and status ``` -------------------------------- ### GET /api/v1/contacts Source: https://seedlycrm.com/docs/help/api Retrieve contact information by email address to identify the sender of an inbound message. ```APIDOC ## GET /api/v1/contacts ### Description Retrieves a list of contacts matching the provided email address. ### Method GET ### Endpoint /api/v1/contacts ### Parameters #### Query Parameters - **email** (string) - Required - The email address to search for. ``` -------------------------------- ### opportunity.won Source: https://seedlycrm.com/docs/help/webhooks Fires when an opportunity is marked as won. ```APIDOC ## opportunity.won ### Description Fires when an opportunity is marked as won. ### Response Example { "event": "opportunity.won", "timestamp": "2026-03-27T14:41:00.000Z", "data": { "subAccountId": "sa_001", "contactId": "abc123", "opportunityId": "opp001", "pipelineId": "pipe001", "title": "Website Redesign", "value": 5000 } } ``` -------------------------------- ### POST /api/calendars/appointments Source: https://seedlycrm.com/docs/help/api Book a new appointment. ```APIDOC ## POST /api/v1/calendars/appointments ### Description Book a new appointment. ### Method POST ### Endpoint /api/v1/calendars/appointments ``` -------------------------------- ### Rate Limit and Retry-After Headers Source: https://seedlycrm.com/docs/help/api HTTP response headers provided for rate limit monitoring and retry logic. ```http Retry-After: 12 X-RateLimit-Limit: ... X-RateLimit-Remaining: 0 X-RateLimit-Reset: 1743091200 ``` ```http X-RateLimit-Limit: ... X-RateLimit-Remaining: ... X-RateLimit-Reset: ... ``` -------------------------------- ### POST /api/v1/contacts Source: https://seedlycrm.com/docs/help/api Create a new contact record. ```APIDOC ## POST /api/v1/contacts ### Description Create a new contact record. ### Method POST ### Endpoint /api/v1/contacts ``` -------------------------------- ### GET /api/v1/conversations/{conversationId}/messages Source: https://seedlycrm.com/docs/help/api Retrieve recent messages from a specific conversation to provide context for AI processing. ```APIDOC ## GET /api/v1/conversations/{conversationId}/messages ### Description Fetches recent messages within a conversation to provide history for chatbot logic. ### Method GET ### Endpoint /api/v1/conversations/{conversationId}/messages ### Parameters #### Path Parameters - **conversationId** (string) - Required - The unique identifier of the conversation. #### Query Parameters - **limit** (integer) - Optional - The maximum number of messages to retrieve. ``` -------------------------------- ### POST /api/v1/contacts Source: https://seedlycrm.com/docs/help/api Creates a new contact record. ```APIDOC ## POST /api/v1/contacts ### Description Creates a new contact in the system. ### Method POST ### Endpoint /api/v1/contacts ### Parameters #### Request Body - **firstName** (string) - Required - First name - **lastName** (string) - Required - Last name ### Response #### Success Response (201) - **contact** (object) - The created contact object ``` -------------------------------- ### Trigger a Workflow via Webhook Source: https://seedlycrm.com/docs/help/api Use the workflow slug to trigger an automation sequence. If a signing secret is configured, the X-Webhook-Signature header is required. ```http POST https://{YOUR_DEPLOYMENT_URL}/webhooks/workflow/{slug} ``` ```json { "contactId": "optional_contact_id", "email": "jane@example.com", "customData": "any data your workflow needs" } ``` ```json { "ok": true, "triggered": 1 } ``` -------------------------------- ### POST /api/v1/conversations Source: https://seedlycrm.com/docs/help/api Create a new conversation. ```APIDOC ## POST /api/v1/conversations ### Description Create a new conversation. ### Method POST ### Endpoint /api/v1/conversations ``` -------------------------------- ### Inject Events into Running Workflows Source: https://seedlycrm.com/docs/help/api Send custom events to workflows waiting at goal nodes. ```http POST https://{YOUR_DEPLOYMENT_URL}/webhooks/event/{slug} ``` ```json { "eventType": "payment_completed", "contactId": "optional_contact_id", "data": { "amount": 99.99 } } ``` -------------------------------- ### form.submitted Source: https://seedlycrm.com/docs/help/webhooks Fires when a public form is submitted. ```APIDOC ## form.submitted ### Description Fires when a public form is submitted. ### Payload Example { "event": "form.submitted", "timestamp": "2026-03-27T14:43:00.000Z", "data": { "subAccountId": "sa_001", "contactId": "abc123", "formId": "form001", "submissionId": "sub001", "formName": "Contact Us", "fields": { "name": "Jane Doe", "email": "jane@example.com", "message": "I'd like more info about your services" } } } ``` -------------------------------- ### Verify Webhook Signature V2 Source: https://seedlycrm.com/docs/help/webhooks Implementation for verifying the X-Webhook-Signature-V2 header using Node.js crypto. Ensure the rawBody is the exact byte stream received before any parsing. ```javascript import crypto from "node:crypto"; // `rawBody` must be the exact bytes received, not a re-serialized object. function verify(rawBody, headers, secret, toleranceMs = 5 * 60 * 1000) { const timestamp = headers["x-webhook-timestamp"]; const expected = crypto .createHmac("sha256", secret) .update(`${timestamp}.${rawBody}`) .digest("hex"); const received = (headers["x-webhook-signature-v2"] || "").replace("sha256=", ""); const a = Buffer.from(expected, "hex"); const b = Buffer.from(received, "hex"); // Constant-time compare, then reject anything too old to be a live delivery. if (a.length !== b.length || !crypto.timingSafeEqual(a, b)) return false; return Math.abs(Date.now() - Number(timestamp)) < toleranceMs; } ``` -------------------------------- ### Create Conversation Endpoint Source: https://seedlycrm.com/docs/help/api Endpoint for initiating a new conversation or retrieving an existing one. ```http POST /api/v1/conversations ``` -------------------------------- ### opportunity.deleted Source: https://seedlycrm.com/docs/help/webhooks Fires when an opportunity is deleted. ```APIDOC ## opportunity.deleted ### Description Fires when an opportunity is deleted. ### Payload Example { "event": "opportunity.deleted", "timestamp": "2026-03-27T14:51:00.000Z", "data": { "subAccountId": "sa_001", "contactId": "abc123", "opportunityId": "opp001", "pipelineId": "pipe001", "name": "Website Redesign" } } ``` -------------------------------- ### invoice.paid Source: https://seedlycrm.com/docs/help/webhooks Fires when an invoice payment is received. ```APIDOC ## invoice.paid ### Description Fires when an invoice payment is received. ### Payload Example { "event": "invoice.paid", "timestamp": "2026-03-27T14:44:00.000Z", "data": { "subAccountId": "sa_001", "contactId": "abc123", "invoiceId": "inv001", "amount": 1500, "currency": "usd", "paidAt": "2026-03-27T14:44:00.000Z" } } ``` -------------------------------- ### Webhook Verification Source: https://seedlycrm.com/docs/help/webhooks Details on the security headers provided with each webhook delivery and the recommended verification process. ```APIDOC ## Webhook Security Verification ### Description Every webhook delivery includes security headers to verify the origin and integrity of the request. It is recommended to use `X-Webhook-Signature-V2` for replay protection. ### Headers - **X-Webhook-Signature** (string) - HMAC-SHA256 of the raw request body. - **X-Webhook-Signature-V2** (string) - HMAC-SHA256 of `Your Company Name | 123 Main St, City, State ZIP
You are receiving this email because you opted in.