ConnectorApiEndpointTemplate

Type: Object

An ApiEndpointTemplate will be turned into an ApiEndpoint on installation. This allows a Connector to bind to incoming HTTP requests from an external system. ApiEndpoints give event-driven capabilities in response to changes in other systems, an efficient and reliable way of building sophisticated connectivity.

Any required configuration options should be defined in the Connector's configuration.

IMPORTANT: This requires a connectivity path to the platform from the external system. If this is hosted on the internet and publically available, then this should be simple, but other topographies may require additional configuration or infrastructure.

Fields

Name	Type	Args	Description	Deprecated
contentType	ContentTypeEnum!		The expected incoming content type to enable parsing of the request body, if present
functionTemplate	String!		The Lua script to run when a webhook request is received by this ApiEndpoint.
httpVerb	HttpVerbEnum!		The HTTP Verb to respond to
name	String!		A name to refer to the Webhook by, aids in human comprehension
path	String!		The path to respond on, this is nested under the Connector's base url and supports dynamic path segments, e.g. /users/:id