View

View information about one or more installed event hooks.

Tokens

This action requires the following tokens:

  • eventhook-view

Arguments

Required arguments are marked in bold, and optional arguments are marked in italics.

Argument Type Default Description
eventhook Hash   If given, show only information on this event hook
event String   If given, show only information on hooks on this event
limit Integer 20 The maximum number of results to include in the output
offset Integer 0 The number of results to skip when outputting
orderfield String id

Defines the field to order the results by; can be any of the following:

  • id – Order lexicographically by ID
order String asc Sort the results by the field given in orderfield in ascending or descending order, by using ‘asc‘ or ‘desc‘ respectively

Output

This action produces the following extra headers on success, besides the default headers:

Name Type Description
count Integer The total number of results that would be returned when pagination would be disabled

This action produces the following output on success:

An array containing zero or more elements, each one being an object containing the following fields:

Name Type Description
id Hash ID of this event hook
event String Name of the event this event hook reacts on
account

Account that this event hook reacts on; if not set, this event is not limited to an account

The value of this field is an object containing the following fields:

Name Type Description
id Hash Account ID
name String Account name
type String Label of the type of this event hook
target String Target of this event hook
createduser

If set, the user that created this event hook

The value of this field is an object containing the following fields:

Name Type Description
id Hash User ID
username String User name
createdapplication

If set, the application that created this event hook

The value of this field is an object containing the following fields:

Name Type Description
id Hash Application ID
name String Application name
description String Application description
iplock IP Mask IP-lock data for this application
datecreated DateTime When the application was created
datemodified DateTime When the application was last modified
active Boolean Whether this application is active
account Hash Account for this application
customer Hash Customer for this application
timezone TimeZone Timezone for this application

Errors

This action can return one of the default status codes, or one of the following status codes on error:

STATUS_EVENT_NOT_FOUND (150)
The given event name is not an existing event.