Skip to main content

List Webhooks

GET 
/v1/products/:productId/webhooks

This endpoint returns the list of the Webhooks that belongs to the given Product identified by the productId parameter, which can be obtained from the List Products endpoint.

Request​

Path Parameters

    productId uuidrequired

    The identifier of the Product.

Responses​

Schema

  • Array [

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