Some of the hookpoints used most commonly are listed below along with the context provided to the workflow.
Reading and understanding the following information require detailed knowledge of hookpoints and workflows. For details regarding the available context objects and return values please refer to the Workflow Admin tool under the Hookpoint Explorer.
These hookpoints may not be available in all installations.
Sign-Up
| Hookpoint key | Dynamic key(s) | Invocation | Notes |
|---|---|---|---|
| SIGNUP | Sign flow for regular signup, started after registering the user's information in Selfcare or Customer Care | ||
| SIGNUP_NP | Sign flow for Number Porting signup, started after registering the user's information in Selfcare or Customer Care | Only available for specific countries. | |
| TELESERVICE_MOBILE_SIGNUP | Sign flow for regular signup, started after registering the user's information in Selfcare or Customer Care. | Only available for services of type TELE. | |
| TELESERVICE_MOBILE_SIGNUP_NP | Sign flow for Number Porting signup, started after registering the user's information in Selfcare or Customer Care. Only available for services of type TELE. | Only available for services of type TELE. |
Termination
| Hookpoint key | Dynamic key(s) | Invocation | Notes |
|---|---|---|---|
| SUB_CAN_TERMINATE | Invoked by Customer Care and other workflows to resolve if a subscription can be terminated. | ||
| TERMINATE_SUBSCRIPTION | Handling the scheduled termination of subscriptions. Can be invoked from all parts of the system. | ||
| SUB_REACTIVATE | Invoked by Customer Care and other workflows to resolve if a subscription can be re-activated. | ||
| SUBSCRIPTION.TERMINATION.CHARGE_ITEM | Invoked when the subscription is terminated. | ||
| GET_DEFAULT_TERMINATION_DATE | Invoked when the termination date is to be calculated in Customer Care. |
Product Options
| Hookpoint key | Dynamic key(s) | Invocation | Notes |
|---|---|---|---|
| PRODUCT_OPTION_CAN_MODIFY | <OPTION_KEY> = The key value of the product option | Invoked from Customer Care when determining if a product option and be subscribed or unsubscribed. | |
| PRODUCT_OPTION_SUBSCRIBE | <OPTION_KEY> = The key value of the product option | Invoked when the specific product option with the OPTION_KEY is subscribed to from any part of the system | |
| PRODUCT_OPTION_UNSUBSCRIBE | <OPTION_KEY> = The key value of the product option | Invoked when the specific product option with the OPTION_KEY is unsubscribed from any part of the system | |
| PRODUCT_OPTION_SUBSCRIBE | Invoked when any product option is subscribed to from any part of the system | ||
| PRODUCT_OPTION_UNSUBSCRIBE | Invoked when any product option is unsubscribed to from any part of the system | ||
| PRODUCT_OPTION_SWITCH | <OPTION_KEY> = The key value of the new product option | Invoked at a change between product options that are exclusive, i.e. the parent option marked the sub-options as exclusive, or the option is part of an exclusive group. |
Campaigns
| Hookpoint key | Dynamic key(s) | Invocation | Notes |
|---|---|---|---|
| <ALERT_HOOKPOINT> | <ALERT_HOOKPOINT> e.g. "ALERT_HOOKPOINT = myAlertWorkflowHookpointKey" | Invoked when specific configurable alert levels have been exceeded. The levels are defined on the PARAMETERS of the bundle configuration and is a comma separated list of numbers (percentages), e.g. "ALERT_LEVEL=25, 50, 75, 100" | The alert hookpoint for bundles is fully configured in the bundle configuration and has no static part. (see documentation for Campaign and bundle configuration: The RestrictActive Framework). Not supported by all campaigns types. |
| CAMPAIGN.ASSIGN.IS_ALLOWED | <CAMPAIGN_KEY> | Invoked when an attempt is made to assign a campaign. The result of the workflow will tell if assigning is allowed. | Not supported by all campaigns types. |
| CAMPAIGN.ASSIGN.GENERATE_OBJECTS | <CAMPAIGN_KEY> | Invoked when an campaign is assigned and the activation is not activated yet. | A workflow linked to this hookpoint is intended to generate the objects used by the hookpoint: CAMPAIGN.ASSIGN.PERSIST_OBJECTS Not supported by all campaigns types |
| CAMPAIGN.ASSIGN.PERSIST_OBJECTS | <CAMPAIGN_KEY> | Invoked when an assigned campaign is assign and saved | Not supported by all campaigns types |
| CAMPAIGN.ACTIVATE.IS_ALLOWED | <CAMPAIGN_KEY> | Invoked when attempting to assign a campaign. The result of the workflow will tell if activation is allowed or not. | Not supported by all campaigns types |
| CAMPAIGN.ACTIVATE.GENERATE_OBJECTS | <CAMPAIGN_KEY> | Invoked when an assigned campaign is activated and the activation is not saved yet. | A workflow linked to this hookpoint is intended for generating the objects used by the hookpoint: CAMPAIGN.ACTIVATE.PERSIST_OBJECTS Not supported by all campaigns types. |
| CAMPAIGN.ACTIVATE.PERSIST_OBJECTS | <CAMPAIGN_KEY> | Invoked when an assigned campaign is activated and saved | Not supported by all campaigns types. |
| CAMPAIGN | ONASSIGN / ONACTIVATE / ONEXPIRE / ONTERMINATE | Invoked when a campaign is assigned, activated, expires or terminated | Not supported by all campaigns types. |
Fees
| Hookpoint key | Dynamic key(s) | Invocation | Notes |
|---|---|---|---|
| FEE_CALC_NEXT_CHARGE_DATE | <SUBSCRIPTION_FEE_CODE> | Invoked when the next charge date of a fee is calculated. Usually on the charge date. | Not supported by all fee types |
| FEE.PRIOR | <PLAN_ELEMENT_NAME> with the first part ('PRE-', 'POST-', 'ONCE-' or 'SINGLE-') stripped | This hookpoint is invoked before a fee is billed or refunded | Not supported by all fee types |
| FEE.AFTER.BILL | <PLAN_ELEMENT_NAME> with the first part ('PRE-', 'POST-', 'ONCE-' or 'SINGLE-') stripped | Invoked after the fee is billed | Not supported by all fee types |
| FEE.CHARGE_ITEM | This hookpoint is invoked when a fee is billed. The hookpoint returns the charge item to be used in the billing process. | Not supported by all fee types | |
| FEE.CALCULATE.PRICE | <PLAN_ELEMENT_NAME> with the first part ('PRE-', 'POST-', 'ONCE-' or 'SINGLE-') stripped | Invoked when a fee is billed. The hookpoint returns the price of billing the given fee with the given context. | Not supported by all fee types |
Invoices
| Hookpoint key | Dynamic key(s) | Invocation | Notes |
|---|---|---|---|
| INVOICE.BEFORE.CLOSE | Invoked before the invoice is closed | ||
Dunning
| Hookpoint key | Dynamic key(s) | Invocation | Notes |
|---|---|---|---|
| <INVOICE.FLOW.STEP> | The hookpoint is defined on the database table field: INVOICE_FLOW_STEP_DEF_METHOD.META_DATA: E.g. {"values":{"HOOKPOINT_KEY":"INVOICE.FLOW.REMINDER"}} | Invoked for every defined step on the invoice flow. | Part of the Invoice Flow Engine. |
| INVOICE.FLOW.CANCEL | <INVOICE_FLOW_CANCEL_STEP_NUMBER> | Invoked when an invoice or a billing group is no longer in an invoice flow. | Part of the Invoice Flow Engine. |
SIM Cards
| Hookpoint key | Dynamic key(s) | Invocation | Notes |
|---|---|---|---|
| SIMCARD_STOLENBLOCK | <PRODUCT_HOOKPOINT_KEY> | Invoked when the SIM card is blocked in Customer Care or via workflow, with Stolen as the reason. | |
| SIMCARD_HARDBLOCK | <PRODUCT_HOOKPOINT_KEY> | Invoked when the SIM card is blocked in Customer Care or via workflow, with hard-block as the type. | |
| SIMCARD_SOFTBLOCK | <PRODUCT_HOOKPOINT_KEY> | Invoked when the SIM card is blocked in Customer Care or via workflow, with the soft-block as the type. | |
| SIMCARD_FRAUDBLOCK | <PRODUCT_HOOKPOINT_KEY> | Invoked when the SIM card is blocked in Customer Care or via workflow, with fraud as the reason. | |
| SIMCARD_UNBLOCK | <PRODUCT_HOOKPOINT_KEY> | Invoked when the SIM card is unblocked in Customer Care or via workflow, after it has been soft-blocked. | |
| SIMCARD_REACTIVATE | <PRODUCT_HOOKPOINT_KEY> | Invoked when the SIM card is reactivated in Customer Care or a via workflow, after it has been hard-blocked. |
A-Numbers
| Hookpoint key | Dynamic key(s) | Invocation | Notes |
|---|---|---|---|
| CHANGE_ANUMBER | Invoked when a change a-number request has been issued from any part of the system |
Recharge Tickets
| Hookpoint key | Dynamic key(s) | Invocation | Notes |
|---|---|---|---|
| RECHARGE_TICKET.CALCULATE_RECHARGE_AMOUNT | Dynamic hookpoint key provided by the RechargeTicketType's meta data | Invoked when the recharge ticket is used to perform a top-up | Not available in all recharge ticket implementations |
| RECHARGETICKET.BEFORE.DELETE | Invoked before the recharge ticket is deleted | Not available in all recharge ticket implementations |
Other
| Hookpoint key | Dynamic key(s) | Invocation | Notes |
|---|---|---|---|
| GET_PHONE_NUMBER_FOR_SMS | Invoked when an SMS message needs to be sent to the customer, and the phone number on the service should not be used | ||
| GET_LONG_DESCRIPTION_SERVICE_ | <SERVICE_CODE> | Invoked when adding or replacing information shown on the Subscription tab in Customer Care | |
| CHANGE_RATEPLAN | Invoked when starting a Rate Plan Change (by clicking the OK button in the ChangePricePlan Dialog, or when the change is done by the RatePlanChangeEngine) | ||
| CAN_DELETE_LOCKIN | Indicates whether a subscription lock-in may be deleted | ||
| CANCEL_NP_FLOW | Invoked when cancellation of a number porting flow has been requested via Customer Care | ||
| CAN_CANCEL_NP_FLOW | Invoked when determining whether the button for cancelling of the number porting flow is available. |