Receiving Cascade Information

Last updated: 12 January 2025

The api/cascade/get-all method is used to get information about cascades.

Calling the api/cascade/get-all method

To call the api/cascade/get-all method, send a POST request to the URL https://app.edna.io/api/cascade/get-all

If the request is successful, the method returns a response with the code 200 and an array of JSON objects. [{...}, {...}, {...}] with the response parameters.

If you have blocked signatures, the response format will contain information about the block.

Request Format

The request body contains an empty JSON object in curly brackets {}

Response Parameters

Parameter	Data type	Description
id	long	Cascade ID. It is specified in the cascadeId attribute when sending messages.
name	string	The name of the cascade specified when creating the cascade.
status	string	Cascade status. For example, ACTIVE or DISABLED.
stagesCount	string	The number of steps in the cascade.
stages	object	Information about cascades. The array contains a description of the cascade composition.
order	long	Sequence number of the cascade step.
uuid	string	The step ID assigned by the system.
decision	object	Description of the step. It can be null or contain type: "TTL", "ttl": "00:00:40", where ttl is the time after which to proceed to the described step if the message was not delivered in the previous step.
subject	object	Information about the channel.
subject.id	long	Signature ID.
subject.name	string	The channel name specified when creating the channel.
subject.subject	string	Signature name.
subject.description	string	Additional information about the channel.
subject.type	string	Channel type. For example, VIBER, WHATSAPP.
subject.tenantId	long	Your account ID.

Response Example

Response example if the request is successful and all cascades are active

[
    {
        "id": 2563,
        "name": "wa-viber",
        "status": "ACTIVE",
        "stagesCount": 3,
        "stages": [
            {
                "order": 1,
                "uuid": "55cf6d4b-2e99-4b25-8930-c81cd66bd114",
                "decision": {
                    "type": "TTL",
                    "ttl": "00:01:00"
                },
                "subject": {
                    "id": 18532,
                    "name": "RETAIL2_WA_EM_temp",
                    "subject": "RETAIL2_WA_EM_temp",
                    "type": "WHATSAPP",
                    "tenantId": 334,
                    "testing": false,
                    "locked": false,
                    "approveStatus": "APPROVED"
                },
                "stages": [
                    {
                        "order": 2,
                        "uuid": "db80e215-2088-4782-9f73-c8f8b1e7d644",
                        "decision": {
                            "type": "TTL",
                            "ttl": "00:01:00"
                        },
                        "subject": {
                            "id": 16724,
                            "name": "RETAIL2_VIBER_EM",
                            "subject": "RETAIL2_VIBER_EM",
                            "type": "VIBER",
                            "tenantId": 334,
                            "testing": false,
                            "locked": false,
                            "approveStatus": "APPROVED"
                        },
                        "stages": []
                    }
                ]
            }
        ]
    }
]

Response example if the request is successful and the disabled cascade is returned

[
    {
        "id": 2533,
        "name": "whatsapp-conversation",
        "status": "DISABLED",
        "stagesCount": 1,
        "stages": [
            {
                "order": 0,
                "uuid": "85e891e5-c6e4-430c-a687-c5beefd270b4",
                "subject": {
                    "id": 18532,
                    "name": "RETAIL2_WA_EM_temp",
                    "subject": "RETAIL2_WA_EM_temp",
                    "type": "WHATSAPP",
                    "tenantId": 334,
                    "testing": false,
                    "locked": false,
                    "approveStatus": "APPROVED"
                },
                "stages": []
            }
        ]
    }
]