Skip to main content

Get Webhook

GET 
/v1/webhooks/:webhookId

This endpoint returns the metadata of a Webhook identified by the webhookId.

Request​

Path Parameters

    webhookId int32required

    The identifier of the Webhook.

Responses​

When everything is ok, the webhook data is returned.

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...