Get Alert By Plan Id

4 min

Endpoint Information

URL: <your-gateway-url>/alert/plan/

Method: GET

Authentication: Required (Bearer Token)

Response Body

{
    "data": [
        {
            "id": 173,
            "planId": 766,
            "alertType": "EMAIL",
            "target": "[email protected]",
            "targetId": null,
            "targetType": null,
            "alertSendingStatus": "Beginning of the Each Execution",
            "alertSendingStatusResult": null,
            "language": null,
            "targetTimeZone": null,
            "enabled": true,
            "unsubscribeLinkEliminated": false
        },
        {
            "id": null,
            "planId": 766,
            "alertType": "EMAIL",
            "target": "[email protected]",
            "targetId": null,
            "targetType": null,
            "alertSendingStatus": "End of the Each Execution",
            "alertSendingStatusResult": [
                {
                    "id": 171,
                    "name": "Test Successful"
                }
            ],
            "language": null,
            "targetTimeZone": null,
            "enabled": true,
            "unsubscribeLinkEliminated": false
        }
    ],
    "result": {
        "code": 0,
        "message": "success"
    }
}

Parameter	Type	Description
alertType	String	Type of alert to send
alertSendingStatus	String	Defines when the alert will be triggered
target	String	Recipient of the alert.
alertSendingStatusResults	Array	List of test result statuses for which alerts should be sent
targetId	Long	Optional ID referencing a predefined alert target in the system.
targetType	String	Optional target type
language	String	Language code for the alert message content (e.g., "en", "tr").
targetTimeZone	String	Time zone for scheduling or timestamp adjustments (e.g., "Europe/Istanbul").

Parameter	Type	Description
data	Object	The payload of the response. In this case null since no extra data is returned.
result	Object	Contains details about the outcome of the operation.
result.code	Integer	The result code (e.g., 0 indicates success).
result.message	String	A message describing the outcome (e.g., "success").

Error Codes

HTTP Code	Error Message	Description
401	UNAUTHORIZED	The request lacks valid authentication credentials. Check your Bearer token.
400	INVALID_REQUEST	The request was malformed or contained errors.
500	INTERNAL_SERVER_ERROR	An unexpected error occurred on the server side.

Example Request

curl --location --request GET '<your-gateway-url>/alert/plan/{planId}' \
--header 'accept: application/json, text/plain, */*' \
--header 'authorization: Bearer <your_access_token>' \
--header 'content-type: application/json' \
--data-raw '{
  "alertType": "EMAIL",
  "alertSendingStatus": "Beginning of the Each Execution",
  "target": "[email protected]",
  "alertSendingStatusResults": [],
  "targetId": null,
  "targetType": null,
  "language": null,
  "targetTimeZone": null
}'