Update Webhook

Update fields of a webhook subscription. Only supplied properties are changed.

PUT /webhooks/{webhook_id}

Update webhook

cURL

curl --request PUT \
  --url https://app.timelines.ai/integrations/api/webhooks/{webhook_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event_type": "message:sent:new",
  "enabled": true,
  "url": "http://www.example.com/api/hook"
}
'

import requests

url = "https://app.timelines.ai/integrations/api/webhooks/{webhook_id}"

payload = {
    "event_type": "message:sent:new",
    "enabled": True,
    "url": "http://www.example.com/api/hook"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    event_type: 'message:sent:new',
    enabled: true,
    url: 'http://www.example.com/api/hook'
  })
};

fetch('https://app.timelines.ai/integrations/api/webhooks/{webhook_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.timelines.ai/integrations/api/webhooks/{webhook_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'event_type' => 'message:sent:new',
    'enabled' => true,
    'url' => 'http://www.example.com/api/hook'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.timelines.ai/integrations/api/webhooks/{webhook_id}"

	payload := strings.NewReader("{\n  \"event_type\": \"message:sent:new\",\n  \"enabled\": true,\n  \"url\": \"http://www.example.com/api/hook\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://app.timelines.ai/integrations/api/webhooks/{webhook_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"event_type\": \"message:sent:new\",\n  \"enabled\": true,\n  \"url\": \"http://www.example.com/api/hook\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.timelines.ai/integrations/api/webhooks/{webhook_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"event_type\": \"message:sent:new\",\n  \"enabled\": true,\n  \"url\": \"http://www.example.com/api/hook\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "status": "ok",
  "data": {
    "id": 789456,
    "event_type": "message:sent:new",
    "enabled": true,
    "url": "http://www.example.com/api/hook",
    "errors_counter": 0
  }
}

{
  "message": "<string>",
  "status": "error",
  "error_code": "validation_error",
  "errors": [
    {
      "fields": [
        "url"
      ],
      "msg": "must be a valid http(s) URL"
    }
  ]
}

{
  "message": "<string>",
  "status": "error",
  "error_code": "validation_error",
  "errors": [
    {
      "fields": [
        "url"
      ],
      "msg": "must be a valid http(s) URL"
    }
  ]
}

{
  "message": "<string>",
  "status": "error",
  "error_code": "validation_error",
  "errors": [
    {
      "fields": [
        "url"
      ],
      "msg": "must be a valid http(s) URL"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

webhook_id · string · required

an ID of webhook

Body

application/json

A JSON describing webhook.

Partial representation used to update an existing webhook. Any omitted field keeps its current value.

event_type · enum<string>

Event topic that will trigger the webhook. For the current list of supported values see the Webhooks events documentation (for example: message:sent:new, message:received:new).

Available options: message:new, message:sent:new, message:received:new, whatsapp:account:connected, whatsapp:account:disconnected, whatsapp:account:suspended, whatsapp:account:resumed, chat:new, chat:incoming:new, chat:outgoing:new, chat:responsible:assigned, chat:responsible:unassigned, call:incoming:missed, call:incoming:ended, call:outgoing:ended, message:reaction

Example:

"message:sent:new"

enabled · boolean

Set to true to resume deliveries or false to pause them.

Example:

true

url · string

Destination HTTPS endpoint that TimelinesAI will call. Must be publicly accessible and respond with 2xx status within 5 seconds. The URL must be a structurally valid http(s):// URL — TimelinesAI rejects URLs that contain characters or shapes that would prevent a standard HTTP client from dispatching to them (for example, unescaped + or = in the userinfo portion). The validator runs on POST /webhooks and PUT /webhooks/{id}; a malformed URL is rejected with 400 validation_error.

Maximum string length: 4096

Example:

"http://www.example.com/api/hook"

Response

200

application/json

Success

Standard envelope returning a single webhook in the data field.

status · enum<string> · required

Available options: ok, error

Example:

"ok"

data · object · required

Server generated representation of a webhook subscription including its unique identifier and delivery error statistics.

Show child attributes