Skip to main content

Replace Webhook

PUT 
/v1/webhooks/:webhookId

This endpoint replaces the whole value of a Webhook identified by the webhookId parameter.

Important: As this endpoint is doing a complete replace, it's important to set every other attribute that you don't want to change in its original state. Not listing one means it will reset.

Request​

Path Parameters

    webhookId int32required

    The identifier of the Webhook.

Body

required

    url stringrequired

    Possible values: >= 7 characters and <= 1000 characters, Value must match regular expression ^(https?:\/\/(?:www\.|(?!www)|(?!a-zA-Z))[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]\.[^\s]{2,}|https?:\/\/(?:www\.|(?!www)|(?!a-zA-Z))[a-zA-Z0-9]\.[^\s]{2,})$

    The URL of the Webhook.

    content stringnullable

    Possible values: <= 15000 characters

    The HTTP body content.

    httpMethod WebHookHttpMethod

    Possible values: [get, post]

    webHookHeaders

    object[]

    nullable

    List of HTTP headers.

  • Array [

    • key stringrequired

    Possible values: non-empty and <= 255 characters, Value must match regular expression ^[a-zA-Z0-9_\-]*$

    The HTTP header key.

    value stringrequired

    Possible values: non-empty and <= 1000 characters, Value must match regular expression ^[a-zA-Z0-9\- _\\:;.,\/"'?!(){}\[\]@<>=+*#$&|~^%]*$`

    The HTTP header value.

    isSecure boolean

    Indicates whether the header value is sensitive.

  • ]

Responses​

When the replace was successful.

Schema

    webhookId int32

    The identifier of the Webhook.

    url stringnullable

    The URL of the Webhook.

    httpMethod WebHookHttpMethod

    Possible values: [get, post]

    content stringnullable

    The HTTP body content.

    webHookHeaders

    object[]

    nullable

    List of HTTP headers that the Webhook must send.

  • Array [

    • key stringrequired

    Possible values: non-empty and <= 255 characters, Value must match regular expression ^[a-zA-Z0-9_\-]*$

    The HTTP header key.

    value stringrequired

    Possible values: non-empty and <= 1000 characters, Value must match regular expression ^[a-zA-Z0-9\- _\\:;.,\/"'?!(){}\[\]@<>=+*#$&|~^%]*$`

    The HTTP header value.

    isSecure boolean

    Indicates whether the header value is sensitive.

  • ]

    • config

    object

    The Config where the applied changes will invoke the Webhook.

    name stringnullable

    The Config's name.

    configId uuid

    The Config's identifier.

    environment

    object

    The Environment where the applied changes will invoke the Webhook.

    name stringnullable

    The Environment's name.

    environmentId uuid

    The Environment's identifier.

Loading...