Set up Ethoca spoke

  • Release version: Australia
  • Updated March 12, 2026
  • 3 minutes to read

    • Integrate the ServiceNow instance with the Ethoca account using the using the OAuth protocol (version 1.0a) for the Consumer Clairty category and using Basic Auth credentials for the Issuers Alert Management category to authenticate ServiceNow requests.

    Before you begin

    • Request an Integration Hub subscription.
    • Activate the Ethoca spoke.
    • Role required: admin.

    For the Consumer Clarity category

    Integrate the ServiceNow instance with the Ethoca account in the Consumer Clarity category using the OAuth protocol (version 1.0a) to securely authorize and authenticate ServiceNow requests.

    Follow these steps:

    Attach a Ethoca certificate

    Use the certificate generated during the Ethoca account configuration to sign the request and payloads.

    Before you begin

    • Valid Ethoca certificate
    • Role required: admin

    Procedure

    1. Navigate to All > System Definition > Certificates.
    2. Click New.
    3. On the form, fill in the fields:
      Table 1. X.509 Certificate form fields
      Field Description
      Name Enter a name to identify the certificate.
      Type Type of the certificate. Select PKCS12 Key Store.
      Notify on expiration Select the list of users to be notified when the certificate expires.
      Warn in days to expire Enter the number of days when a notification is sent to users before a certificate expires.
      Key store password Password to access the certificate. Use the destination keystore password specified when creating the certificate.
      Active Option to make the client certificate active.
      Short description Short description of the user client certificate.
    4. Click the manage attachments icon (Manage attachments icon.) and attach a Ethoca certificate.
    5. Click Validate Stores/Certificates to validate the certificate.
    6. Click Submit.

    Create credential records

    Create a credential record for your Ethoca account. The Ethoca spoke connection and credential alias uses these credentials to authorize actions.

    Before you begin

    Role required: admin

    Procedure

    1. Navigate to All > Connections & Credentials > Credentials.
    2. Select New.

      The system displays this message: What type of Credentials would you like to create?

    3. Select Ethoca Credential.
      A blank Ethoca Credential form displays.
    4. Enter these values.
      Field Value required
      Name Enter any name to uniquely identify the record. For example, Ethoca Credentials.
      Active Enable
      Key alias Key alias associated with the Ethoca account.
      Keystore password Password associated with the certificate.
      Consumer key Consumer key that you generated during the Ethoca configuration.
      Certificate Select the newly created Ethoca certificate.
      Authentication Algorithm Custom authentication algorithm for outbound signing requests. Select Ethoca.
      Note:
      Users are cautioned against directly modifying the default authentication algorithm.
    5. Click Submit.

    Create connection records

    Create a connection record for your Ethoca account. The Ethoca spoke connection and credential aliases use these connections to perform actions in Ethoca.

    Before you begin

    Role required: admin

    Procedure

    1. Navigate to All > Connections & Credentials > Connections & Credentials Aliases.
    2. Open for the record for Ethoca.
    3. On the Connections tab, click New.
    4. On the form, fill these values.
      Field Value required
      Connection URL Base URL to connect to your Ethoca instance. Enter: https://sandbox.api.ethocaweb.com/ethoca .
      Credential Credential record that you created for Ethoca. For example, Ethoca Credentials.
    5. Right-click the form header and click Save.

    For the Issuer Alerts Management category

    Integrate the ServiceNow instance with the Ethoca account in the Issuer Alerts Management category using Basic Auth credentials to authenticate ServiceNow requests.

    Follow these steps:

    Create basic auth credentials

    Create credentials to access a ServiceNow instance.

    Before you begin

    Role required: admin

    Procedure

    1. Navigate to Connections & Credentials > Credentials.
    2. Click New.
    3. Select Basic Auth Credentials.
    4. On the form, fill in the fields.
      Field Description
      Name Unique name to identify the credential record. For example, Ethoca Alerts Credentials
      User name Name to identify the user.
      Password Password to use this credential.
      Active Option to actively use the credential record. Select the option.
      Order The order (sequence) in which the platform tries this credential while it attempts to log in to devices. Default value: 100.
    5. Select Submit.

    Create connection records

    Create a connection record for your Ethoca account. The Ethoca spoke connection and credential aliases use these connections to perform actions in Ethoca Alerts.

    Before you begin

    Role required: admin

    Procedure

    1. Navigate to All > Connections & Credentials > Connections & Credentials Aliases.
    2. Open for the record for Ethoca Alerts.
    3. On the Connections tab, click New.
    4. Fill the form.
      Table 2. Configure Connection
      Field Description
      Connection Name Name of the connection established with the Ethoca instance. The first connection's default name is automatically assigned to match the name specified in the Connections and Credentials form on the Connection & Credential Aliases page.
      Credential Credential record you that created for Ethoca Alerts. For example, Ethoca Alerts Credentials.
      Connection URL Base URL to connect to your Ethoca instance. Enter: https://sandbox.ethocaweb.com/ethoca-rest.
    5. Right-click the form header and click Save.