PUT Webhooks

Update Webhook

id : required Passed as URL parameter, specifying which webhook to update.

PUT /api/v3/{appid}/webhook/hooks/{id}

Requires Authentication.

id : (required) Passed as URL parameter, specifying which webhook to update.
label : (required) A unique string for your webhook. It can be anything you want.
url: (required) A URL to post to when the webhook is activated.
enabled: (required) Sets the webhook to be in either the enabled or disabled states.
type: (required) ["prepublish"/"postpublish"] Sets the type of webhook. See TYPES in the description for the "Create Webhook" API method.
events: (required) An array of strings indicating which event types activate your webhook. See events below.

Additional Details

See "Create or Replace Webhook" method for details about webhook behavior and settings.

Request

Parameters

Values in the path and query string.

appid path

string TalkLabs ID required

The TalkLabs application ID assigned to your account.

Example: your-app-id

id path

string required

Request

JSON body

Send as application/json.

label

string required

url

string required

enabled

boolean required

webhookType

integer · int32 required

events

WebhookEventTypes[] required

entities

string[]

requiredCustomTags

string[]

Request example

{
  "label": "Demonstration Webhook Re-Labeled",
  "url": "https://localhost:443",
  "enabled": false,
  "events": [
    "speech",
    "custom",
    "reply",
    "reaction",
    "action",
    "enter",
    "exit",
    "roomopened",
    "roomclosed",
    "purge"
  ],
  "webhookType": {}
}

Response

Status codes

Every JSON response uses the API result envelope.

200 OK ApiResult

400 Bad Request ApiResult

403 Forbidden ApiResult

500 Internal Server Error ApiResult

curl --request PUT \
  --url "https://api.sportstalk247.com/api/v3/${APP_ID}/webhook/hooks/${_ID}" \
  --header "Accept: application/json" \
  --header "x-api-token: ${TALKLABS_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "label": "Demonstration Webhook Re-Labeled",
  "url": "https://localhost:443",
  "enabled": false,
  "events": [
    "speech",
    "custom",
    "reply",
    "reaction",
    "action",
    "enter",
    "exit",
    "roomopened",
    "roomclosed",
    "purge"
  ],
  "webhookType": {}
}'

const appId = process.env.TALKLABS_APP_ID;
const id = '<id>';

const response = await fetch(
  `https://api.sportstalk247.com/api/v3/${appId}/webhook/hooks/${id}`,
{
  method: 'PUT',
  headers: {
    Accept: 'application/json',
    'x-api-token': process.env.TALKLABS_API_TOKEN,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "label": "Demonstration Webhook Re-Labeled",
  "url": "https://localhost:443",
  "enabled": false,
  "events": [
    "speech",
    "custom",
    "reply",
    "reaction",
    "action",
    "enter",
    "exit",
    "roomopened",
    "roomclosed",
    "purge"
  ],
  "webhookType": {}
}),
});

const result = await response.json();

import json
import os
import requests

app_id = os.environ["TALKLABS_APP_ID"]
id = "<id>"

response = requests.put(
    f"https://api.sportstalk247.com/api/v3/{app_id}/webhook/hooks/{id}",
    headers={
        "Accept": "application/json",
        "x-api-token": os.environ["TALKLABS_API_TOKEN"],
    },
    json=json.loads(r'''{
  "label": "Demonstration Webhook Re-Labeled",
  "url": "https://localhost:443",
  "enabled": false,
  "events": [
    "speech",
    "custom",
    "reply",
    "reaction",
    "action",
    "enter",
    "exit",
    "roomopened",
    "roomclosed",
    "purge"
  ],
  "webhookType": {}
}'''),
)
response.raise_for_status()
result = response.json()

Environment variables TALKLABS_APP_ID TALKLABS_API_TOKEN

Response