Configuring the endpoints for publishing events

In Sterling Intelligent Promising to activate event publishing, you must configure the Webhook or the IBM Cloud® Object Storage endpoint connectivity.

Before you begin

  1. Familiarize yourself with the following concepts:
For IBM Cloud Object Storage, following the steps 1 and 2.
  1. Provision your IBM Cloud Object Storage bucket. For more information, see Getting started with IBM Cloud Object Storage.

    Assign only one data type to a IBM Cloud Object Storage bucket.

  2. Gather the following provisioning information about your IBM Cloud Object Storage bucket to provide to the file transfer adapter:
    • Private endpoint URL for your IBM Cloud Object Storage service instance.
    • IAM key for IBM Cloud Object Storage. For more information, see IAM overview.
    • Your bucket name.
For webhooks, review the webhook documentation and ensure that you have provisioned a web server that uses OAuth 2.0 authentication and they have the details of webhook and OAuth server. The server must be online during provisioning.

About this task

The event publish rule guides the system to process events and determines where to publish them.

Procedure

  1. Log in to Order Hub.
  2. From the menu, click Endpoints.
  3. Select the Publish tab.
    The Endpoints page opens with the following configuration information:
    Field name Description
    Entity The event type for which you configure a publish event rule.
    • Click any Entity link to view the endpoint details. An Entity link is available only when you configure a rule. To sort the entities, hover over the Entity column and select the Sort icon.
    Description A description of the event type
    File type The type of file that is supported by the endpoint, for example, a Events file.
    Status The status of the endpoint and whether it is configured. An entity stays in an unconfigured state until you activate or configure it.
    • Valid options are Configured or Unconfigured.
    Actions Edit an endpoint that is configured or configure an endpoint.
    You can select any column heading to sort the information.
  4. To configure an endpoint, click the Edit icon for an endpoint that is in the Unconfigured status. On the Endpoint details page, provide the endpoint information.
  5. To activate the endpoint, slide the Status toggle to Active.
  6. Optional: To skip failed events, slide the Skip failed events toggle to Off.
  7. Select one of the following endpoints and provide the Webhook or theIBM Cloud Object Storage details.
    • Webhook - In the Webhook Details section, provide the following information:
      Field name Description
      URL The HTTPS type of URL where the webhook events are posted.
      Token duration (hrs) The length of time a token is valid for in hours.
      Delivery format The format in which the events are delivered, including JSON Array or Object. The default format is Array. For more information, see New event delivery format.
      Token URL The HTTPS type of URL where Oauth2 tokens are available.
      OAuth2 client ID
      The client id for the Oauth2 token server
      OAuth2 client secret
      The client secret for the Oauth2 token server
    • IBM Cloud Object Storage - In the Bucket details section, provide the following information:
      Field name Description
      URL The private endpoint URL for the bucket from the bucket configuration screen.
      Bucket name The customer bucket name.
      Prefix (optional) The prefix value of the storage location in the bucket for event data.
      In the Credentials section, provide the following information:
      Field name Description
      API key The IAM API key that has Writer access to the bucket.
  8. Click Save.
  9. To view the endpoint details for an existing configuration, on the Endpoints page, click any of the entity links that have a Configured status.
    The Endpoint details page displays the configuration details.
  10. Edit or delete a configuration.
    • To edit the configuration information, on the Endpoints page, click the Edit icon. Edit the endpoint configuration details and click Save.

    There is an toggle button to change the active toggle to inactive. This change stops the event publishing but the endpoint configuration can be saved.

    • To delete a configuration, on the Endpoints details page, click the Edit menu and edit the details or click Delete endpoint configuration. In the Confirm delete dialog, click Delete.