Before you start
- Define the intended outcome, owner, permissions, and source of truth.
- Use a small non-sensitive test.
- Record the current configuration before changing it.
- Confirm workspace availability in the current UI.
Steps
- Open Company Settings and API & Webhooks.
- Read the linked technical documentation for the exact endpoint.
- Create one named key per integration and move it directly to a secret store.
- Test with an isolated test list or contact.
- Log timestamp, event ID, status code, and safe response metadata.
- Rotate or revoke keys when unused or exposed.
Safety checks
- The correct workspace, object, view, period, or endpoint is selected.
- Permissions, ownership, required fields, and protected data were reviewed.
- The test result was checked in the destination or final dataset.
- Credentials and internal evidence are not exposed.
Troubleshooting
| Problem | Solution |
|---|
| Webhook arrives twice | Use an event ID and idempotent processing. |
| A key was shared | Revoke or rotate it immediately and inspect logs. |
| A request fails | Check endpoint, method, authentication, payload, and safe response details. |
Frequently asked questions
Why should I test first?
A controlled test exposes mapping, permission, data, and ownership errors before broad impact.
Can I assume every workspace has this feature?
No. Use the current UI and confirmed provisioning.
What should screenshots hide?
Credentials, tokens, personal data, customer records, internal URLs, and identifiers.
Who should own the configuration?
Assign an accountable administrator and a business owner.
What should I document?
Purpose, scope, owner, fields or filters, test result, and review date.
When should I contact support?
When availability, saved state, permissions, or results remain inconsistent after a controlled check.
Keep reading
Understand Analytics
Compare the same period, list, sender, channel, and campaign before drawing conclusions from activity and replies.
Filter contacts, choose columns, and export
Filter the correct Contacts view, select only needed columns, and export a reviewed dataset to protected storage.
Connect Zoho CRM or Pipedrive
Connect a supported CRM and validate authentication, user mapping, and field delivery with one controlled test.
