Configure the Custom Endpoints app

  • Updated

The OCP database is not included in the free version of OCP. The free version syncs data in real-time without using the OCP database, letting you access public apps and data syncs.

Contact your Customer Success Manager if you have any questions.

Use the Optimizely Connect Platform (OCP) Custom Endpoints app to create webhook endpoint URLs that you can send data to for automatic ingestion into your OCP account. Then, you can sync the URLs to other Optimizely products.

This is a good option to get data into OCP without requiring developer resources.

Prerequisite

You must create the target objects (database tables) and fields (database table columns) in the OCP database before you import data through the Custom Endpoints app. See Add custom objects and fields.

Create custom webhook endpoint URLs

You can repeat these steps to create as many custom webhook endpoint URLs as needed to import data into OCP.

  1. Go to Data Setup > App Directory.

  2. Select the Custom Endpoints app.

  3. Click Install App, then go to the Settings tab.
  4. Click Create new webhook and complete the following:
    • Name – Enter a name for the webhook that represents the data you plan to sync with the webhook.
    • Object – Select the object (database table) where you want to sync the data.
  5. Click Next.

  6. Enter the JSON Payload you want to import and click Process JSON payload. This automatically creates the data fields included in the payload. If you do not have a JSON payload, you can manually create the data fields instead by defining the Field Name and Field Type for each field.

  7. Click Next.
  8. Map the fields you created in step six to your existing OCP fields that you created before configuring this integration.
    • Incoming Fields – Select one of the fields you created in step six.

    • Hub Object Fields – Select the OCP field to which you want to map the incoming field.

  9. Click Save Field Map and repeat the process for each field you want to map. Each time you add a field mapping, it displays in the table in the Map fields section.

    You can also delete a field mapping at any point by selecting the Field Map and clicking Delete Field Map.

  10. Click Finish. The custom webhook endpoint URL displays in the Status section.

  11. Copy the webhook endpoint URL and use it to configure a webhook in the corresponding platform. In this example, you would use this URL to configure a webhook in Contentful. When you configure the webhook, you can only sync data for which you have already created objects and fields in OCP, and then configured in the Custom Endpoints app.

At this point, the data begins syncing automatically to OCP. Going forward, updates sync to OCP in real-time when you update connected data in the third-party platform (like Contentful).

If you try to sync data that you have not properly connected to OCP, it is ignored in the syncs or might return an error. You can check for errors in the OCP Settings > Activity Log.

Sync data to other Optimizely products

Now that you have data in OCP, you can sync it out of OCP to other Optimizely products using data syncs. See Create a data sync.