Moab Web Services > References > Resource Reference > Services > Fields: Service Global Hook Definitions

Fields: Service Global Hook Definitions

See the associated Services resource section for more information on how to use this resource and supported operations.

Additional references

Type	Value	Additional information
Permissions resource	services/hooks/global-definitions	Permissions
Hooks filename	services.hooks.global-definitions.groovy	Pre- and Post-Processing Hooks
Tenant-supported	Yes	Tenants
Distinct query-supported	Yes	Distinct

API version 3

ServiceGlobalHook

Field Name	Type	POST	PUT	Description
id	String	No	No
currentPhase	ServicePhase	No	No	The service phase that will trigger a running instance of this hook definition when the service leaves the phase.
includeServiceAsBody	Boolean	No	No	If set to true, the service json body we be piped to the STDIN of the script. Defaults to false
name	String	No	No	The service hook definition name.
nextPhase	ServicePhase	No	No	The service phase that will trigger a running instance of this hook definition when the service enters the phase.
timeoutInSeconds	Long	No	No	The duration in seconds before the hook will timeout and terminate automatically, resulting in a failure. Defaults to 900 seconds (15 minutes) when not specified.
transition	Transition	No	No	The service phase transition that will trigger a running instance of this hook definition.
type	ServiceHookType	No	No	The type of service hook that will be run. Before hook failures will stop the service phase transition from taking place.
url	String	No	No	The executable script to be run. e.g. exec:///opt/mws/hooks/service-hooks/hook1.sh?arg1&arg2

ServicePhase

Transition

Enumerates all the signals that a Service can respond to, which may cause a transition to a new phase of the service's lifecycle.

ServiceHookType

Value	Description
Before
After