Guides Home MangoApps Website Community & Support Blog & Resources

Webhooks

Configuring the profile webhooks for 2-way sync

Profile Webhook

You can sync profile data to and from external third-party software/APIs using webhooks for various trigger events.

Profile Webhook Settings

The Profile Webhook settings is for the outgoing data from your MangoApps domain to external third-party software/APIs.

  1. Select Trigger Events: Mark the trigger events to push data to external third-party software/APIs. You can choose triggers for Create User, Update User Profile, and Activate/Deactivate User events. The system pushes data whenever the marked trigger takes place on your domain.

  2. Post to URL: Specify the external third-party software/APIs URL to push and sync the profile data to an external server or data source.

  3. Request Parameters: Enter the external system ID for request parameters in the API Field text box and select the MangoApps profile field from the MangoApps Field drop-down to map the data. Click the + Add button to add more request parameters and click the Remove button to remove a request parameter.

  4. Response Parameters: Enter the external system ID for response parameters in the API Field text box and select the MangoApps profile field from the MangoApps Field drop-down to map the data. Click the + Add button to add more response parameters and click the Remove button to remove a response parameter.

The external system ID for the request and response parameters MUST match your third-party API field for successful exchanges. Refer your third-party API specifications for the API fields for user profiles.

Notifying MangoApps Settings

The Notifying MangoApps settings is for the incoming data from external third-party software/APIs into your MangoApps domain.

  1. MangoApps URL: The MangoApps URL you can use to push and sync the profile data from your server or data source.

  2. Input Parameters: Enter the external system ID for input parameters in the API Field text box and select the MangoApps profile field from the MangoApps Field drop-down and mark the User Identifier check box to map the data. Click the + Add button to add more input parameters and click the Remove button to remove an input parameter.

The external system ID for the input parameters MUST match your third-party API field for successful exchanges. Refer your third-party API specifications for the API fields for user profiles and the configuration of the webhooks.

Security Settings

  1. To setup OAuth based authentication: Click the Webhook Security link to configure the OAuth based authentication for your MangoApps domain.

PreviousSkillsNextPosts

Last updated