The HTTP Notifier (REST) output connection will POST results from the system to a specified HTTP endpoint.
If you would like to use the HTTP Notifier connection in a SaaS instance and your service is not public, you should create a firewall pinhole for the connection. Contact your Hyperscience representative for more information.
Sample use cases
Send extracted information to a downstream system for further processing.
Add extracted information back as metadata on the document from which it was extracted.
Send custom notifications to an API to alert other systems to take an action.
Block settings table
In addition to the settings outlined below, you can also configure the settings described in Universal Integration Block Settings.
Name | Required? | Description |
|---|---|---|
Authorization Type | Yes | The type of authorization the connection will use when sending notification requests to your downstream system:
Your selection determines which of the fields below are shown in the connection settings. |
Endpoint URL | Yes | The URL that output notifications will be posted to. |
Endpoint URL Secrets | No | A list of secret key names and values to be sent as parameters in the endpoint URL. Enter each name-value pair in its own line of text. Example: |
Authorization Header | Yes, if available | The content of the notification request's Authorization header. This setting is only available if Authorization Type is set to HTTP Header. |
OAuth2 Authorization URL | Yes, if available | The URL of your downstream system's authorization server that will issue the connection's access token. This setting is only available if Authorization Type is set to OAuth2 2.0 Client Credentials. |
Client ID | Yes, if available | The client ID for the connection, as issued by your downstream system during the application-registration process. This setting is only available if Authorization Type is set to OAuth2 2.0 Client Credentials. |
Client Secret | Yes, if available | The client secret for the connection, as issued by your downstream system during the application-registration process. To edit the secret, click Edit value, modify the secret, and then click Done. This setting is only available if Authorization Type is set to OAuth2 2.0 Client Credentials. |
Audience | Yes, if available | The resource service URL that will be sent to the OAuth2 Authorization URL, along with the client credentials, when obtaining the access token. This setting is only available if Authorization Type is set to OAuth2 2.0 Client Credentials. |
Timeout (Seconds) | No | Specify a timeout value for the HTTP request. |
SSL Certificate Settings: Trusted Certificate(s) | Yes, if available | The root / server certificate for the connection in PEM format. This setting is only available if SSL Certificate Settings: Source is set to Use SSL certificate. |
Setting up HTTP Notifier
To set up the HTTP Notifier, enter the settings as described in the Block settings table above. You do not need to make any customizations to your APIs.
To ensure that your submissions do not halt after completion, set a “200” response with a non-empty body from your downstream system to the HTTP Notifier.