Creating Subscriptions

Create a subscription to listen for Control Hub events and then complete an action when those events occur.

  1. In the Navigation panel, click Monitor > Subscriptions.
  2. Click the Add icon: .
  3. Enter a name and optionally a description.
  4. Under Event, select the event type to subscribe to:
    • Execution Engine Not Responding
    • Data SLA Triggered
    • Job Status Change
    • Max Global Failover Retries Exhausted
    • Pipeline Committed
    • Pipeline Status Change
  5. Optionally, define a condition to filter the events to subscribe to.

    To define an advanced expression using the IBM StreamSets expression language, select Use Advanced Editor.

  6. Under Action, select the action type to use:
    • Webhook
    • Email
  7. For a webhook action, configure the following properties:
    Action Property Description
    HTTP Method HTTP request method to use:
    • GET
    • POST
    • DELETE
    • PUT
    URI URI to send the HTTP request to.
    Content Type Optional content type of the payload. Available for PUT, POST, and DELETE methods.

    For example, enter application/json if sending a message in JSON format in the payload.

    If you do not specify a content type, Control Hub uses text/plain as the content type.
    Payload Optional payload to use. Available for PUT, POST, and DELETE methods.

    Use any valid content type.

    You can use parameters in the payload to include information about the triggering event, such as the job name or state. Enclose webhook parameters in double curly brackets as follows: {{JOB_NAME}}. For more information, see Parameters.
    Authentication Type Authentication type to include in the request:
    • None
    • API Key
    • Bearer Token
    • Basic
    • OAuth 2.0
    Key API key to authenticate with the receiving system.

    Available when using the API Key authentication type.
    Value API value to authenticate with the receiving system.

    Available when using the API Key authentication type.
    Location Where to include authentication information in the request.
    For API Key authentication, select one of the following locations:
    • Header - Encodes the API key and value in the request header.
    • Query Parameters - Encodes the API key and value in the URI as query parameters.
    For OAuth 2.0 authentication, select one of the following locations:
    • Send as Basic Auth header - Encodes the client credentials in the request header.
    • Send client credentials in body - Encodes the client credentials in the request body.

    Available when using the API Key or the OAuth 2.0 authentication type.
    Token Bearer token to authenticate with the receiving system.

    Available when using the Bearer Token authentication type.
    Username User name to authenticate with the receiving system.

    Available when using the Basic authentication type.
    Password Password to authenticate with the receiving system.

    Available when using the Basic authentication type.
    Account Token URL URL used to request the access token from the HTTP service.

    Available when using the OAuth 2.0 authentication type.
    Client ID Client ID that the HTTP service uses to identify the HTTP client.

    Available when using the OAuth 2.0 authentication type.
    Client Secret Client secret that the HTTP service uses to authenticate the HTTP client.

    Available when using the OAuth 2.0 authentication type.
    Scope Optional scope for the request, when required by the receiving system.

    Available when using the OAuth 2.0 authentication type.
    Resource Optional list of resources for the request, when required by the authorization server.

    Specify when the authorization server requires that a client request access to specific resources, rather than all resources in the receiving system. The authorization server issues access tokens that are valid only for the specified resources.

    Available when using the OAuth 2.0 authentication type.
    Audience Optional audiences for the request, when required by the receiving system.

    Available when using the OAuth 2.0 authentication type.
    Timeout Milliseconds to establish a connection to the receiving system.

    Default is 30000 milliseconds.
    Headers Optional HTTP request headers.
  8. For an email action, configure the following properties:
    Action Property Description
    Subject Email subject line.

    You can use parameters in the subject line to include information about the triggering event, such as the job name or state. Enclose parameters in double curly brackets as follows: {{JOB_NAME}}. For more information, see Parameters.
    Recipients The individuals to receive the email. Separate multiple email addresses with a comma. Email aliases are not supported.

    Control Hub does not validate email addresses.
    Body The email message.

    You can use parameters in the email body to include information about the triggering event, such as the job name or state. Enclose webhook parameters in double curly brackets as follows: {{JOB_NAME}}. For more information, see Parameters.
  9. Click Save.