# CiviCRM integration

CiviCRM is a web-based, open-source CRM that meets the needs of nonprofit organizations and other civil society organizations. It is easy to use, customize, and extend.

With sipgate, you can call directly from CiviCRM and use your contacts in the sipgate app. This way, you can always see which contact is currently calling and do not have to switch between different tools. sipgate is your phone system with the telephony app for desktop and mobile.

**Integration of CiviCRM in the sipgate app:**

{% stepper %}
{% step %}
**Select integration**

In the sipgate app, click the gear icon on the left and select the item "Integrations".

Under "Integrations", search for the entry "CiviCRM" and click the "Connect with CiviCRM" button. ![civicrm.png](/files/967ae301f80d48dd1d231649e962d3d930966dc6)
{% endstep %}

{% step %}
**Enter API data**

Enter the required API key and API URL here.

![civicrm\_api.png](/files/863124e689ee2f27443024794cce5cf2e46905fc)
{% endstep %}

{% step %}
**Confirm connection**

This means you have successfully connected CiviCRM and the sipgate app.

{% hint style="info" %}
Note: Depending on the number of contacts to be integrated, it may take a few minutes before they are displayed completely.
{% endhint %}
{% endstep %}
{% endstepper %}

**Find or create the API key in your CiviCRM account:**

{% hint style="warning" %}
**Important: To be able to create an API key, the API Key Management module must first be installed. In CiviSpark, it is installed but not activated. To activate it, please contact CiviCRM support.**
{% endhint %}

{% stepper %}
{% step %}
**Activate module**

You can find the settings for the API Key Management module in your CiviCRM account under "Administration", "System Settings", "Extensions".

![civicrm1.png](/files/8136944644dab0b670401fb1bbcb556ccd5707aa)

The API Key Management module.

![civicrm2.png](/files/c43d00dbe228d8357b0b7a38910621cadb0e5c52)
{% endstep %}

{% step %}
**Search for contact**

After successful activation, select "Search" in the top navigation and then the submenu "Find Contacts".

![civicrm3.png](/files/4eaf849fff06f737049239872a6e204dbdebadc9)

In the new window, you can leave all fields blank and click the "Search" button directly.

![civicrm4.png](/files/faf5a7689931730cd9569a2aed04785b9f7d4a0e)

Select any contact.

![civicrm5.png](/files/992e3a537174228c582decace687f511ec4682dc)
{% endstep %}

{% step %}
**Create user account**

Now click the "Action" button in the top left of the window.

![civicrm6.png](/files/f369ae376b95fbce5332a860e1b5ca30fafe30ee)

Select "Create user account".

![civicrm7.png](/files/bc80366def40920d0da3314e2304cc4abd8bbc5e)
{% endstep %}

{% step %}
**Assign administrator role**

Click "Edit" in the menu and select "administrator" under "Roles". Save your entry with the "Save" button. ![civicrm8.png](/files/8c3f537ce3c1875380071b190d2e04aac9af0615)
{% endstep %}

{% step %}
**Generate API key**

Now return to the detail page of the selected contact and select the "API Key" entry on the left. Then click the "+ Add API Key" button on the right in the window. ![civicrm9.png](/files/8b77f1a89e651a6d377a6c2efb6777c84ccab1cb)

By pressing the "Generate" button, you create a new API key.

![civicrm10.png](/files/86a87b7decb3598b228bd9466de21b6efed0af6e)
{% endstep %}
{% endstepper %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://help.sipgate.de/cloud-telefonanlage/en/connections-and-integrations/integrationen-fur-die-sipgate-app/civicrm-integration.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.