Getting Started
This guide is for developers building integrations with Crewsum. Learn how webhooks enable you to respond asynchronously to events in your Crewsum account, allowing you to build powerful integrations with external services.
What are Webhooks?
Section titled “What are Webhooks?”Webhooks are HTTP callbacks that notify your application when specific events occur in Crewsum. Unlike polling for changes, webhooks push data to your endpoint in real-time, enabling efficient, event-driven integrations.
How Webhooks Work
Section titled “How Webhooks Work”When an event occurs in Crewsum (such as creating or updating a client, project, or task), the system sends an HTTP POST request to your configured webhook URL. This request includes a JSON payload with details about the event and the affected data.
Your application receives the webhook, processes the payload, and can then trigger actions like updating an external CRM, sending notifications, or synchronizing data with other systems.
Supported Events
Section titled “Supported Events”Crewsum supports webhooks for various entity changes, including:
- Clients (created, updated, deleted)
- Projects (created, updated, deleted)
- Tasks (created, updated, deleted)
- Associations (created, updated, removed)
- Suppliers and supplier contacts
- Users
- Timesheets and timecards
See the events documentation for detailed information about each event type and payload structure.
Next Steps
Section titled “Next Steps”To start using webhooks:
- Create a webhook in your Crewsum account
- Configure your endpoint to handle incoming webhook requests
- Test your integration with the supported events
Security Considerations
Section titled “Security Considerations”- Always validate webhook signatures to ensure requests come from Crewsum
- Use HTTPS endpoints to secure data transmission
- Implement retry logic to handle temporary failures