Register callback endpoint

Available in Classic and VPC

Register default callback endpoint that will receive event notifications for all channels.

Callback delivery data

When you register a callback endpoint, data is sent to the specified endpoint URL whenever an event occurs. It uses the HTTP POST method for sending data. The following describes the delivery data.

An example of delivery data is as follows:

{
    "id": 1234,
    "logLevel": "INFO",
    "channelId": "ls-20200327******-aBCD3",
    "event": "STREAM_UPDATE",
    "timestamp": 1599218791425
}

Request

This section describes the request format. The method and URI are as follows:

Request headers

For information about the headers common to all Live Station APIs, see Live Station request headers.

Request body

You can include the following data in the body of your request:

Request example

The request example is as follows:

curl --location --request POST 'https://livestation.apigw.ntruss.com/api/v2/events/callbackEndpoint' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'x-ncp-region_code: KR' \
--header 'Content-Type: application/json' \
--data '{
    "callbackUrl": "https://www.callback-endpoint.com"
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Response status codes

For information about the HTTP status codes common to all Live Station APIs, see Live Station response status codes.

Response example

The response example is as follows:

{
    "content": {
        "callbackUrl": "https://www.callback-endpoint.com",
        "updateTime": 1755750398046
    }
}