Interface: EventToWebHookConfig

Defined in: type/EventToWebHookConfig.ts:6

The configuration for posting a payload to a WebHook when an event gets triggered which has the url as a field to store where to post the payload to.

Properties

code?

optional code?: string

Defined in: type/EventToWebHookConfig.ts:12

The event code to use when the trigger is [CUSTOM_EVENT]

---

createdAt

createdAt: string

Defined in: type/EventToWebHookConfig.ts:14

The creation date of this EventActionConfig

---

createdBy?

optional createdBy?: number

Defined in: type/EventToWebHookConfig.ts:18

ID of the user who created this EventActionConfig

---

id

id: string

Defined in: type/EventToWebHookConfig.ts:8

The ID of the event, uuid v7 format

---

lastModifiedAt

lastModifiedAt: string

Defined in: type/EventToWebHookConfig.ts:16

The last modified date of this EventActionConfig

---

lastModifiedBy?

optional lastModifiedBy?: number

Defined in: type/EventToWebHookConfig.ts:20

ID of the user who last modified this EventActionConfig

---

names

names: LocalizedString[]

Defined in: type/EventToWebHookConfig.ts:22

names field

---

trigger

trigger: EventTrigger

Defined in: type/EventToWebHookConfig.ts:10

The event to trigger the action defined in the event action config

---

url

url: string

Defined in: type/EventToWebHookConfig.ts:24

The URL of the webhook to send the payload to