Skip to main content

OAuth2 connection

Description​

OAuth 2.0 is an authorization framework that enables applications — such as Facebook*, GitHub, or a CRM system — to obtain limited access to user resources on another service without putting the credentials at risk.

With this connection type, you can connect Altcraft Platform to any external service that uses OAuth2 as an authorization method.

Where is the connection used:

  • Node "API call". You can transfer information from the scenario to the connected service or, on the contrary, request the API content from the service. Use this option if you need to transfer the data of the profile captured by the scenario to the CRM system.

  • Action Hooks. The event capture mechanism will allow you to transfer data about a platform event, including data about the profile associated with that event, to an external service. For example, you can configure a hook that tracks the opening of an email message, and add the profile's email in the custom_data field. In this case, when the message is opened, the profile's data can be passed to your CRM.

  • Import data on a schedule in the Market. To access a protected product feed, authorization via OAuth2 is available.

How to create a connection​

Go to "Settings" → "Connections" and select the OAuth2 connection type:

A list of all configured OAuth2 connections will be shown. To add a new one, click + Create:

Enter the name of the new connection and add a description if necessary:

The platform provides a redirection URI — the URL to which the user will be redirected when they give Altcraft permission to access their data in the plug-in application. Copy the URI and add it to the list of trusted redirection URIs for the application.

Next, specify the details of your application that you need so that the platform can access its resources. You get this data when you register your app and you can find it in the app's settings:

  • Client ID is a public application identifier. Client ID is required for OAuth authorization.
  • Client secret is the application password, known only to the application and the authentication server. Some services do not provide a secret code for OAuth authorization — in this case, leave this field blank.

OAuth operations also require an authorization link and a link to get token. Study the documentation of the connected service to figure out which links are responsible for these operations.

If necessary, you can limit the platform's access to the data by selecting the requested rights:

Click "Connect". You will be redirected to the connected service, where you need to log in and confirm the granting of rights to the platform.

If the connection to the service was completed successfully, save the connection using the buttons in the upper right corner.

Connection settings can be changed at any time. To do this, click "Edit".

*The Meta organization, which owns Instagram, Facebook and WhatsApp products, has been declared as extremist and banned in Russia.

Last updated on