Skip to main content

Create a custom notification endpoint

POST 
/v1/endpoints/custom

Creates a new notification endpoint for a custom integration or sends a test message to the custom endpoint.

Request​

Query Parameters

    test boolean

    To send a test message to the endpoint, true. Otherwise, false.

    Note: If set to true, the notification endpoint is not created. To create the endpoint, you need to send the API request where test=false.

Body

    title string

    Name of the endpoint

    description string

    Detailed description of the endpoint

    url string

    URL where the notification will be sent

    method string

    The HTTP used to send the notification

    headers string

    Header parameters to include, as comma-separated key-value pairs

    bodyTemplate object

    JSON object that serves as the template for the message body.

    property name* object

Responses​

successful operation

Schema
    id int32

    ID of the notification endpoint. If the API call was made where test=true, then no changes are made to the endpoint. In this case, the response body contains {"id": -1} to indicate that a test message was sent.

Loading...