Hook Model

Hooks are nothing more than regular Python functions or Java classes.

All hooks should accept HookArg object parameter.

In JAWCE All class hooks should have a constructor which takes HookArg model as a parameter.

Hook model

Hook Model: HookArg

public record WaCurrentUser(
    String name,        // default user display name
    String waId,        // mobile number
    String msgId,
    Long timestamp
    ) {}

public record TemplateDynamicBody(
    WebhookResponseMessageType type,        // for dynamic template message type
    Map<String, Object> payload,            // used for `flow` type - initial flow data
    Map<String, Object> renderPayload       // dynamic template data
    ) {}

// main model
public class HookArgs {
    private WaCurrentUser channelUser;
    private String userInput;                           // user input from whatsapp
    private String flow;                                // flow name for flow template type
    private Map<String, Object> additionalData;         // mainly for dynamic routing
    private TemplateDynamicBody templateDynamicBody;    // for templates, dynamic and flow messages
    private Map<String, Object> methodArgs;             // provided static params defined on template
}

@dataclass
class WaUser:
    name: str = None
    wa_id: str = None
    msg_id: str = None
    timestamp: str = None

@dataclass
class TemplateDynamicBody:
    typ: MessageTypeEnum = None
    initial_flow_payload: Dict[str, Any] = None
    render_template_payload: Dict[str, Any] = None


# main model
@dataclass
class HookArg:
    """
        additional_data: received data from interactive message type responses.
            E.g a list / flow response
        flow: name of flow from the template
        params: configured template params
        user_input: the raw user input, usually a str
            if message was a button / text
    """
    user: WaUser
    params: Dict[str, Any] = field(default_factory=dict)
    template_body: TemplateDynamicBody = None
    from_trigger: bool = False
    user_input: str = None
    flow: str = None
    additional_data: Dict[str, Any] = None
    session_manager: ISessionManager = None

The Hook model contains all the necessary data you can use in your business logic

Getting Started

Templates

Hooks

Miscellaneous

Hook Model

Hook model

On this page