Configuring Remote Event Handler
To configure a Remote Event Handler:
- Log in to the Billing control panel as a system administrator.
- Go to System > Settings > System > Events. The list of existing Event Types opens.
- Switch to the Event Handlers tab, and press Add New Event Handler. The configuration screen opens.
- Complete the fields:
- Event Type: Choose an event type from the pop-up window. For example, Invoice Created.
- Event Handler Kind: Choose Remote Hander.
-
Complete these additional fields, which appear on the screen after you select Remote Hander above:
- Remote Event Receiver: Select Use Existing (choose an existing Remote Event Receiver), or Create New (complete the fields which appear on the screen).
- HTTP Method: Choose the method from the verb values GET, POST, PUT, or DELETE.
- CloudBlue Commerce sends the Event Type and parameters serialized as a JSON object in the HTTPS requests for the verbs POST and PUT.
- CloudBlue Commerce sends the Event Type and parameters serialized as a QUERY in the HTTPS requests for the verbs GET and DELETE.
- URL Relative Path: Enter the relative path. For example,
/get-event?source=pba
-
Signature: Describe the event parameters and enter their default values (in the same way as for the local event handler type). For example:
- integer AccountID; string Originator=Unknown;
- Complete the other required fields as necessary.
- Press Save. You have successfully created a new Remote Event Handler to process Billing events.