Skip to main content

UpdateWebhookRequest

Schema for updating an existing webhook

name object
anyOf
string

Possible values: non-empty and <= 255 characters

description object
anyOf
string

Possible values: <= 500 characters

url object
anyOf
string<uri>

Possible values: non-empty and <= 2048 characters

events object
anyOf
  • Array [
    • string
  • ]
    • headers object
    anyOf
    object
    auth_type object
    anyOf
    AuthTypeEnum (string)

    Webhook authentication types

    Possible values: [none, bearer, basic, api_key]

    auth_config object
    anyOf
    object
    method object
    anyOf
    MethodEnum (string)

    HTTP methods for webhooks

    Possible values: [POST, PUT, PATCH, GET]

    content_type object
    anyOf
    string

    Possible values: <= 100 characters

    custom_payload_template object
    anyOf
    string
    is_active object
    anyOf
    boolean
    max_retries object
    anyOf
    integer

    Possible values: >= 0 and <= 10

    timeout_seconds object
    anyOf
    integer

    Possible values: >= 1 and <= 300

    rate_limit_per_minute object
    anyOf
    integer

    Possible values: >= 1 and <= 1000

    UpdateWebhookRequest
    {
      "name": "string",
      "description": "string",
      "url": "string",
      "events": [
        "string"
      ],
      "headers": {},
      "auth_type": "none",
      "auth_config": {},
      "method": "POST",
      "content_type": "string",
      "custom_payload_template": "string",
      "is_active": true,
      "max_retries": 0,
      "timeout_seconds": 0,
      "rate_limit_per_minute": 0
    }