API Key Configuration in iCRM

1: API Key Configuration in iCRM: 
To Configure API keys into ICRM, follow the below steps. 

  • Log in to your iCRM Application. 
  • Navigate to the “Admin” Component. 
  • Under Admin Component, navigate to the “SendGrid Configuration Main Menu” and choose “SendGrid Setup” Sub Menu. 

 Navigate to the SendGrid Setup screen in iCRM. 

Fill in the following fields: 

  • Configuration Name: Type “SendGrid API Setup for [Your Client Name]”. 
  • API Key: Paste the API key you generated from SendGrid. 
  • Sender Mail: Enter the sender email address configured in SendGrid. 
  • Sender Name: Enter the sender’s name configured in SendGrid. 
  • Is Default: Select N. 

Save the configuration to apply the settings. 

More Details: 

To configure the SendGrid setup in your iCRM system, you need to fill in the following details in the SendGrid Setup screen: 

Configuration Name: This should be the name of your setting configuration. For example, “SendGrid API Setup for [Client Name]”. 
Example: SendGrid API Setup for ABC Corp 

API Key: Enter the API key that you generated in your SendGrid account. 
Example: SG.xxxxxx… (Replace with your actual API key) 

Sender Mail: Enter the Sender Email address that you have configured in SendGrid. 
Example: [email protected] 

Sender Name: Enter the Sender Name that you have configured in SendGrid. 
Example: ABC Corp Marketing 

Is Default: This value should be set to either Y or N. For this configuration, choose N. 
Example: N 

Here’s a detailed step-by-step guide to fill out the SendGrid Setup screen: 

2: SendGrid Setting: 

In the SendGrid setting, we have 2 parts including below 

  • Capture SendGrid Webhook Event Integration in iCRM 
  • Setup in SendGrid  

Capture SendGrid Webhook Event Integration in iCRM: 
Generate Client ID & Client Secret Key  

  • Log in to your iCRM application 
  • Open the Webtools component in the backend 
  • Navigate to the Run Service section. 
  • Run the Service (Service Name : oauth.generateClientIdAndSecret) 

Use of Service: oauth.generateClientIdAndSecret is used to generate the Client ID and Client Secret key. 

After running the service, we can be able to get the Client ID and Client Secret key. 

To Generate Sample Record: 

To generate the demo data use the Table called WebhookEventClientConfig and create a value from the Webtools 

  • Field: oauthClientId: Set Client ID which is generated above. 
  • Field: oauthClientSecret: Set client Secret Key which is generated above. 
  • Field:  authTypeId: Set OAUTH 
  • Save this value. 

Note: OAuth client ID and secret generation is optional for single-tenant installation. It helps authenticate incoming payload and helps to identify the tenant’s ID. It can be disabled by setting auth required to Y.

SendGrid Setting: 

  • Log in to your SendGrid account. 
  • Navigate to the “Settings” tab. 
  • Select “Mail Settings”  
  • Under the Webhook Setting click on Event Webhooks  
  • Click on the Create New Webhook button  

3: Check Connectivity Between iCRM and SendGrid: 

On the Event Webhook page, we have a button called Test Integration. 

Click on the Test Integration button to see the connectivity between iCRM and SendGrid. 

Related Resources