Hook Action Code: Perl Module Example

ExampleHookAction.pm

# Package this module.
package MyApp::WHM;
   
# Return errors if Perl experiences problems.
use strict;
use warnings;
     
# Properly decode JSON.
use JSON;
   
# Embed hook attributes alongside the action code.
sub describe {
    my $my_add = {
        'category' => 'Whostmgr',
        'event'    => 'Accounts::Create',
        'stage'    => 'post',
        'hook'     => 'MyApp::WHM::add',
        'exectype' => 'module',
    };
  
    return [ $my_add ];
}
  
sub add {
    # Get the data that the system passes to the hook.
    my ( $context, $data ) = @_;               
  
    # Set success and failure messages.
    my $result  = 1;                             # This Boolean value is set to fail.   
    my $message = 'This is an error message.';   # This string is a reason for $result.
     
    # Insert your actions here.
  
    # Return the hook's result and message.
    return $result, $message;
}
  
1;