Skip to main content
Version: Next

WebhookDispatchWebhookSummary

The subset of a webhook that a dispatch carries.

Hierarchy

  • Omit<Schemas[WebhookDispatchWebhookSummary], keyof WebhookDispatchWebhookSummaryRePointed>
  • WebhookDispatchWebhookSummaryRePointed
    • WebhookDispatchWebhookSummary

Index

Properties

Properties

optionalinherited_id

_id?: string
YiKoxjkaS9gjGTqhF

ID of the webhook. The API returns it under _id, not id.

optionalinheritedactionType

actionType?: string
HTTP_REQUEST

optionalinheritedcondition

condition?: WebhookCondition

optionalinheritedgithubIssue

githubIssue?: { body?: string; repository?: string; title?: string; userIntegrationId?: string }

Type declaration

  • optionalbody?: string
    Actor run {{resource.id}} failed.
  • optionalrepository?: string
    apify/apify-docs
  • optionaltitle?: string
    Actor run failed
  • optionaluserIntegrationId?: string
    kLcd8Z4dzXN1z3QzS

optionalinheritedgoogleDrive

googleDrive?: { filename?: string; format?: null | string; transformation?: { fields?: string[]; omit?: string[] }; userIntegrationId?: string }

Type declaration

  • optionalfilename?: string
    results
  • optionalformat?: null | string
    json
  • optionaltransformation?: { fields?: string[]; omit?: string[] }
    • optionalfields?: string[]
      [
            "title",
            "url"
          ]
    • optionalomit?: string[]
      [
            "html"
          ]
  • optionaluserIntegrationId?: string
    kLcd8Z4dzXN1z3QzS

optionalinheritedgoogleMail

googleMail?: { attachmentFormat?: string; attachmentTransformation?: { fields?: string[]; omit?: string[] }; body?: string; emailTo?: string[]; subject?: string; userIntegrationId?: string }

Type declaration

  • optionalattachmentFormat?: string
    csv
  • optionalattachmentTransformation?: { fields?: string[]; omit?: string[] }
    • optionalfields?: string[]
      [
            "title",
            "url"
          ]
    • optionalomit?: string[]
      [
            "html"
          ]
  • optionalbody?: string
    Actor run {{resource.id}} finished.
  • optionalemailTo?: string[]
    [
          "bob@example.com"
        ]
  • optionalsubject?: string
    Actor run finished
  • optionaluserIntegrationId?: string
    kLcd8Z4dzXN1z3QzS

optionalinheritedisAdHoc

isAdHoc?: boolean
false

optionalinheritedisApifyIntegration

isApifyIntegration?: null | boolean
false

optionalinheritedrequestUrl

requestUrl?: null | string

Format: uri

https://example.com/webhook

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

optionalinheritedslackMessage

slackMessage?: { channelId?: string; messageTemplate?: string; userIntegrationId?: string }

Type declaration

  • optionalchannelId?: string
    C01234ABCDE
  • optionalmessageTemplate?: string
    Actor run {{resource.id}} finished.
  • optionaluserIntegrationId?: string
    kLcd8Z4dzXN1z3QzS
Page Options