Skip to main content
Version: Next

Webhook

Represents a webhook configuration.

Webhooks send HTTP POST requests to specified URLs when certain events occur (e.g., Actor run succeeds, fails, or times out).

Hierarchy

  • Omit<Schemas[Webhook], keyof WebhookRePointed>
  • WebhookRePointed
  • WebhookSpecGaps
    • Webhook

Index

Properties

Properties

inheritedcondition

condition: WebhookCondition

inheritedcreatedAt

createdAt: Date

Format: date-time

2019-12-12T07:34:14.202Z

optionalinheriteddescription

description?: null | string
this is webhook description

optionalinheriteddoNotRetry

doNotRetry?: null | boolean
false

inheritedeventTypes

eventTypes: WebhookEventType[]

optionalinheritedheadersTemplate

headersTemplate?: null | string
{\n "Authorization": "Bearer ..."}

inheritedid

id: string
YiKoxjkaS9gjGTqhF

inheritedignoreSslErrors

ignoreSslErrors: boolean
false

optionalinheritedisAdHoc

isAdHoc?: null | boolean
false

optionalinheritedisApifyIntegration

isApifyIntegration?: boolean

optionalinheritedlastDispatch

lastDispatch?: null | WebhookLastDispatch

inheritedmodifiedAt

modifiedAt: Date

Format: date-time

2019-12-13T08:36:13.202Z

optionalinheritedpayloadTemplate

payloadTemplate?: null | string
{\n "userId": {{userId}}...

optionalinheritedrequestUrl

requestUrl?: null | string

Format: uri

http://example.com/

URL of the HTTP request sent by the webhook. It is omitted or null for hook actions other than the conventional HTTP case (e.g. Slack or email notifications).

optionalinheritedshouldInterpolateStrings

shouldInterpolateStrings?: null | boolean
false

optionalinheritedstats

stats?: null | WebhookStats

inheriteduserId

userId: string
wRsJZtadYvn4mBZmm
Page Options