apify-docs/apify-api/openapi/components/schemas/webhooks/WebhookCreate.yaml at f242701dd54bc58b4dc685cde1e72498b7b23545 · apify/apify-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
title: WebhookCreate
required:
  - eventTypes
  - condition
  - requestUrl
type: object
properties:
  isAdHoc:
    type: [boolean, "null"]
    examples: [false]
  eventTypes:
    type: array
    items:
      $ref: ./WebhookEventType.yaml
    examples:
      - [ACTOR.RUN.SUCCEEDED]
  condition:
    $ref: ./WebhookCondition.yaml
  idempotencyKey:
    type: [string, "null"]
    examples: [fdSJmdP3nfs7sfk3y]
  ignoreSslErrors:
    type: [boolean, "null"]
    examples: [false]
  doNotRetry:
    type: [boolean, "null"]
    examples: [false]
  requestUrl:
    type: string
    format: uri
    examples: ["http://example.com/"]
  payloadTemplate:
    type: [string, "null"]
    examples: ['{\n "userId": {{userId}}...']
  headersTemplate:
    type: [string, "null"]
    examples: ['{\n "Authorization": "Bearer ..."}']
  title:
    type: [string, "null"]
    examples: [Actor run succeeded webhook]
  description:
    type: [string, "null"]
    examples: [this is webhook description]
  shouldInterpolateStrings:
    type: [boolean, "null"]
    examples: [false]