Home Main category Incoming Webhooks

Incoming Webhooks

Last updated on Oct 23, 2024

Simply CRM Incoming Webhooks

Welcome to the guide for setting up Incoming Webhooks in Simply CRM. If you haven’t already checked out our introduction to webhooks or are curious about outgoing webhooks, feel free to give them a quick read first to get a fuller picture of how Simply CRM uses webhooks to send and receive data.

We also have a slightly more elaborate guide on How to Create and Manage Incoming Webhooks if you need this.

Incoming webhooks allow Simply CRM to receive data from external systems or applications, automatically creating or updating records without any manual input.


How to Set Up Incoming Webhooks

Here’s how you can set up incoming webhooks in Simply CRM:

  1. Go to Settings: Navigate to Settings > Webhooks > Incoming to manage your incoming webhooks.

  2. Create a New Webhook: Click on the button to create a new webhook.

  3. Fill Out the Webhook Details: When setting up the webhook, you'll be prompted to complete the following fields:

    • Webhook Name: Choose a name to identify your webhook.

    • Module Name: Select the Simply CRM module where the incoming data will be recorded (e.g., Contacts, Deals).

    • Is Active: Choose whether the webhook should be active or paused.

    • Mandatory Fields: Specify which fields must be filled to create or update a record. Fields marked in red are required.

  4. Configure the Data Fields: After selecting your module, define which fields the webhook will populate from the incoming data. For each field, you can choose:

    • VALUE: A fixed value to be used for this field.

    • FIELD: Pull the value directly from the incoming data (JSON).


Testing Your Incoming Webhooks

To make sure everything’s set up correctly, it's important to test your incoming webhooks. You can use tools like Postman or webhook.site to simulate and inspect the incoming data:

  • Postman: Create a POST request to simulate sending data to your webhook. Enter the Simply CRM webhook URL, add your test data in JSON format, and send the request. This helps you check whether your webhook is receiving and processing data as expected.

  • webhook.site: Use webhook.site to inspect the data your webhook receives. Simply trigger an event from your external system, and webhook.site will display the incoming data for you to verify.

Both tools are easy to use, and we’ve mentioned them in our general webhooks guide, so feel free to check that out for more details.


JSON Format for Incoming Webhooks

The data sent to Simply CRM via incoming webhooks is structured in JSON format. This ensures that the information is well-organized and can be processed by Simply CRM. Here’s an example of a typical JSON payload:

jsonKopier kode{
    "event": "new.contact",
    "data": {
        "name": "John Doe",
        "email": "johndoe@example.com",
        "phone": "123456789"
    }
}

This example shows how a new contact’s information (name, email, phone) could be sent to Simply CRM, where the system would create a new record based on the incoming data.


Conclusion

Incoming webhooks are a powerful way to streamline data entry in Simply CRM. By automatically pulling in data from external systems, you can save time and reduce manual work. Whether you’re receiving new signups, updates from other platforms, or any other data, incoming webhooks keep your CRM up-to-date.

Be sure to also check out our guides on outgoing webhooks and the general introduction to webhooks to explore more ways to automate and integrate Simply CRM into your workflows.