Connectors Reference

Eigen Events

Provides events from Ingenuity for use as flow triggers. You can use this connector to start flows whenever a selected event completes in the Eigen Ingenuity System

 

Status: Preview

Tier: Premium

Version: 1.0

 

Actions:

Name

Summary

DeleteWebhook (string webhookId)

Delete a webhook you created

GetSupportedEvents ()

Get Events Available

GetDynamicEventSchema (number eventIds)

Get Dynamic Schema For Event

 

Triggers:

Name

Summary

CreateWebhook (number eventIds, CreateWebhookParameterBody of Trigger Request Body of Trigger Request)

When an event occurs

 

Objects:

Name

Summary

CreateWebhookParameterBody of Trigger Request

 

DynamicSchemaForEvent

 

SupportedEventsBody

 

WebhookCreationResponse

 

 

Actions:

DeleteWebhook

Summary: Delete a webhook you created

Description: This action deletes a webhook you had created

 

Syntax:

EigenEvents.DeleteWebhook (string webhookId)

 

Parameters:

Name

Type

Summary

Required

Related Action

webhookId

string

 

The ID of the webhook to delete

True

 

Returns:

 

GetSupportedEvents

Summary: Get Events Available

Description: This action will fetch all events supported by this server

 

Syntax:

EigenEvents.GetSupportedEvents ()

 

Returns:

          Type:SupportedEventsBody

 

GetDynamicEventSchema

Summary: Get Dynamic Schema For Event

Description: This action will fetch the schema for the selected eventId

 

Syntax:

EigenEvents.GetDynamicEventSchema (number eventIds)

 

Parameters:

Name

Type

Summary

Required

Related Action

eventIds

number

 

Get the schema for event

True

 

Returns:

          Type:DynamicSchemaForEvent

 

Triggers:

Trigger CreateWebhook

Summary: When an event occurs

Description: This operation triggers when any of the events subscribed to occurs

 

Syntax:

EigenEvents.CreateWebhook (number eventIds, CreateWebhookParameterBody of Trigger Request Body of Trigger Request)

 

Parameters:

Name

Type

Summary

Required

Related Action

eventIds

number

(EventID)

Select Event Id

True

GetSupportedEvents

Body of Trigger Request

CreateWebhookParameterBody of Trigger Request

 

 

True

 

Returns:

          Type:WebhookCreationResponse

 


 

CreateWebhookParameterBody of Trigger Request

Summary:

Description:

 

          Properties:

Name

Type

Summary

callbackUrl

CallbackUrl

Callback URL

 

 

CallbackUrl

Summary: Callback URL

Description:

 

          Properties:

Name

Type

Summary

 


 

DynamicSchemaForEvent

Summary:

Description:

 

          Properties:

Name

Type

Summary

schema

Schema

 

The dynamic schema for given event

 

Schema

Summary:

Description: The dynamic schema for given event

 

          Properties:

Name

Type

Summary

 


 

SupportedEventsBody

Summary:

Description:

 

          Properties:

Name

Type

Summary

events

array of (EventsItem)

 

The events supported

 

EventsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

value

number

 

The event id

display

string

 

The event name

 


 

WebhookCreationResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

success

boolean

Webhook created

Webhook created

description

string

Operation succeeded

The success repsonse

value

Value

 

 

 

Value

Summary:

Description:

 

          Properties:

Name

Type

Summary

webhookId

string

 

The webhook Id