Skip to main content

Add a new Webhook Endpoint

POST 
/v3/applications/:appId/envs/:appEnv/webhooks

This endpoint adds a new webhook endpoint to an application environment.

Request​

Path Parameters

    appId stringrequired

    The application identifier which is used to identify the application used.

    Example: appId_XXXX-XXXX-XXXX-XXXX-XXXX
    appEnv stringrequired

    Possible values: [DEVELOPMENT, STAGING, PRODUCTION]

    The execution environment of the application where request are executed.

Body

The details of the webhook endpoint to be added.

    url stringrequired

    The URL where the webhook endpoint will send data to. This is a required property.

    description string

    A human-readable description of the webhook endpoint. This can be used for documentation or additional context.

Responses​

The updated list of webhook settings.

Schema

    _id string

    A unique string identifier for the webhook endpoint.

    url stringrequired

    The URL where the webhook endpoint will send data to.

    description string

    A human-readable description of the webhook endpoint. This can be used for documentation or additional context.

    _createdAt date-time

    The date and time when the webhook endpoint was created, formatted as a string in ISO 8601 format.

Loading...