Knowledgebase

Introduction

Hookable events set the action that triggers a hook, and whether the hook triggers before or after the event. Within any cPanel & WHM event (for example, an API call or binary process), the code contains the following phases:

1. Preparation — The preparation of variables and the environment.

2. Execution — The execution of specific operations.
3. Rendering — The rendering of the operation's results via HTTP content headers and body.

cPanel & WHM events run routines before (pre) or after (post) the execution phase. 

Hookable events

The Standardized Hooks system uses the following categories for hookable events:

• Cpanel  — The Cpanel category creates hookable events for cPanel API 1, cPanel API 2, or UAPI functions.
• PkgAcct  — The PkgAcct category's events occur during backup creation.
• Passwd  — The Passwd category's events occur when a WHM user changes a cPanel user's password.
• Stats  — The Stats category's events occur during statistics processing.
• System  — The System category's events occur during system updates or backups.
• Whostmgr  — The Whostmgr category's events occur during WHM functions.

Hookable event attributes

All hookable events are comprised of three main attributes:

1. category — The event's logical grouping within cPanel & WHM.
2. event — The event that cPanel & WHM performs.
3. stage — The location of the trigger that runs the hook action code, relative to the event.

Some hookable events may include additional attributes:

• blocking — Whether a returned failure from the hook action code prevents the event's execution. Only specific  pre -stage events can block . 
• escalateprivs — Whether the hookable event can escalate privileges before the hook action code runs. (Scripts only.)
• Action Code Run As — The system user that owns the process that executes the hook action code.