Details of API for Sending Notification on the Results from an External Service
This section describes the details of the API for sending notification on results.
- The parameters cannot be changed because the URL is signed.
Method
POST
URL
https://{API end point}/handlers/to-http/{status}?tenantId={tenantId}&docId={docId}&date={date}&expiresIn={expiresIn}&sig={sig}
Path Parameters
| Parameter Name | Description |
|---|---|
| status | Set to "success" or "error". |
Query Parameters
| Parameter Name | Description |
|---|---|
| tenantId | The ID of the tenant that the user that executed the rule belongs to. |
| docId | The ID of the rule that is executing. |
| date | The date and time that the URL was issued. |
| expiresIn | The expiration date of the URL. |
| sig | The signature. |
Request Header
Not required.
Request Body
Not required.
Response
| Status Code | Condition | Message |
|---|---|---|
| 200 | Success | "The status of the rule has been successfully updated." |
| 400 | Insufficient parameters | "The value of the parameter [${key}] is incorrect." |
| 400 | URL expired | "The requested URL has expired." |
| 403 | No signature or invalid signature | "There is no operation authority." |
| 404 | Rule not executing | "The data [${doc-id}] cannot be found." |
| 500 | Internal server error | "Unknown server error occurred." |