Assets

Assets are objects which can be referenced in a flow definition or flow definitions themselves. For example the set_contact_field action references a field asset.

Types

channel

Is something that can send/receive messages.

{
    "uuid": "14782905-81a6-4910-bc9f-93ad287b23c3",
    "name": "My Android",
    "address": "+593979011111",
    "schemes": [
        "tel"
    ],
    "roles": [
        "send",
        "receive"
    ],
    "country": "EC"
}

classifier

Is an NLU classifier.

{
    "uuid": "37657cf7-5eab-4286-9cb0-bbf270587bad",
    "name": "Booking",
    "type": "wit",
    "intents": [
        "book_flight",
        "book_hotel"
    ]
}

field

Is a custom contact property.

{
    "uuid": "d66a7823-eada-40e5-9a3a-57239d4690bf",
    "key": "gender",
    "name": "Gender",
    "type": "text"
}

flow

Is graph of nodes with actions and routers.

{
    "uuid": "14782905-81a6-4910-bc9f-93ad287b23c3",
    "name": "Registration",
    "definition": {
        "nodes": []
    }
}

global

Is a named constant.

{
    "key": "organization_name",
    "name": "Organization Name",
    "value": "U-Report"
}

group

Is a set of contacts which can be added to and removed from manually, or based on a query.

{
    "uuid": "14782905-81a6-4910-bc9f-93ad287b23c3",
    "name": "Youth",
    "query": "age <= 18"
}

label

Is an organizational tag that can be applied to a message.

{
    "uuid": "14782905-81a6-4910-bc9f-93ad287b23c3",
    "name": "Spam"
}

location

Is a searchable hierarchy of locations.

{
    "name": "Rwanda",
    "aliases": [
        "Ruanda"
    ],
    "children": [
        {
            "name": "Kigali City",
            "aliases": [
                "Kigali",
                "Kigari"
            ],
            "children": [
                {
                    "name": "Gasabo",
                    "children": [
                        {
                            "id": "575743222",
                            "name": "Gisozi"
                        },
                        {
                            "id": "457378732",
                            "name": "Ndera"
                        }
                    ]
                },
                {
                    "name": "Nyarugenge",
                    "children": []
                }
            ]
        },
        {
            "name": "Eastern Province"
        }
    ]
}

optin

Are opt-ins for messaging campaign.

{
    "uuid": "8925c76f-926b-4a63-a6eb-ab69e7a6b79b",
    "name": "Joke Of The Day"
}

resthook

Is a set of URLs which are subscribed to the named event.

{
    "slug": "new-registration",
    "subscribers": [
        "http://example.com/record.php?@contact.uuid"
    ]
}

template

Is a message template, currently only used by WhatsApp channels

{
    "name": "greeting",
    "uuid": "14782905-81a6-4910-bc9f-93ad287b23c3",
    "translations": [
        {
            "locale": "eng-US",
            "channel": {
                "uuid": "cf26be4c-875f-4094-9e08-162c3c9dcb5b",
                "name": "Twilio Channel"
            },
            "components": [
                {
                    "name": "body",
                    "type": "body/text",
                    "content": "Hello {{1}}",
                    "variables": {
                        "1": 0
                    }
                }
            ],
            "variables": [
                {
                    "type": "text"
                }
            ]
        },
        {
            "locale": "fra",
            "channel": {
                "uuid": "cf26be4c-875f-4094-9e08-162c3c9dcb5b",
                "name": "Twilio Channel"
            },
            "components": [
                {
                    "name": "body",
                    "type": "body/text",
                    "content": "Bonjour {{1}}",
                    "variables": {
                        "1": 0
                    }
                }
            ],
            "variables": [
                {
                    "type": "text"
                }
            ]
        }
    ]
}

topic

Categorizes tickets

{
    "uuid": "cd48bd11-08b9-44e3-9778-8e26adf08a7a",
    "name": "Weather"
}

user

Is an person who can trigger flows or be assigned tickets etc.

{
    "email": "bob@nyaruka.com",
    "name": "Bob"
}