OBJECT

EventActionTemplate

link GraphQL Schema definition

1type EventActionTemplate {
2
3id: ID!
4
5# The name of template. e.g. "Run engine X for every new mention in a watchlist".
6name: String!
7
8# owner of the template
9organizationId: ID!
10
11# Application this template could be applied to. If application_id is null, then
12# this is an org-wide template.
13ownerApplicationId: ID
14
15# use "event" for now. In the future, we allow additional input_type types. For
16# example, a schedule or a tweet.
17inputType: EventActionTemplateInputType!
18
19# based on the input_type, input_validation describes additional validations. For
20# example, if input_type is "event", input_validation could be a list of allowed
21# events.
22inputValidation: JSONData
23
24# A JSON structure that is compatible/specific to the input_type. For example, if
25# input type is "event", then input_attributes simply contain the entire event
26# payload.
27inputAttributes: JSONData
28
29# Either "job", "webhook", "sms", "email". Future action_type could be "gql"
30# where action is purely a function call.
31actionType: EventActionTemplateActionType!
32
33# Allows you to specify validation for the action_type. For example, if
34# action_type is "job", perhaps only whitelist a list of engines that could be
35# called.
36actionValidation: JSONData
37
38# dedicated column to specify where/what the action is taking place. For example,
39# if action is a job, then destination is an engine_id. For webhook, a uri.
40actionDestination: String!
41
42# A JSON structure that is compatible with action_type. For example, if
43# action_type is "webhook", action_attributes contain the mustache compatible
44# template to format the content. If action_type is "job", then action_attributes
45# need to specify a job template.
46actionAttributes: JSONData
47
48}