Update a webhook endpoint

PATCH

webhooks

{id}

curl --request PATCH \
  --url https://api-us.larynth.com/v1/webhooks/{id} \
  --header 'Content-Type: application/json' \
  --cookie lx_session= \
  --data '
{
  "description": "<string>",
  "event_types": [],
  "url": "<string>"
}
'

import requests

url = "https://api-us.larynth.com/v1/webhooks/{id}"

payload = {
    "description": "<string>",
    "event_types": [],
    "url": "<string>"
}
headers = {
    "cookie": "lx_session=",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {cookie: 'lx_session=', 'Content-Type': 'application/json'},
  body: JSON.stringify({description: '<string>', event_types: [], url: '<string>'})
};

fetch('https://api-us.larynth.com/v1/webhooks/{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://api-us.larynth.com/v1/webhooks/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => '<string>',
    'event_types' => [
        
    ],
    'url' => '<string>'
  ]),
  CURLOPT_COOKIE => "lx_session=",
  CURLOPT_HTTPHEADER => [
    "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://api-us.larynth.com/v1/webhooks/{id}"

	payload := strings.NewReader("{\n  \"description\": \"<string>\",\n  \"event_types\": [],\n  \"url\": \"<string>\"\n}")

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

	req.Header.Add("cookie", "lx_session=")
	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.patch("https://api-us.larynth.com/v1/webhooks/{id}")
  .header("cookie", "lx_session=")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"<string>\",\n  \"event_types\": [],\n  \"url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-us.larynth.com/v1/webhooks/{id}")

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

request = Net::HTTP::Patch.new(url)
request["cookie"] = 'lx_session='
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"<string>\",\n  \"event_types\": [],\n  \"url\": \"<string>\"\n}"

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

{
  "consecutive_failures": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "event_types": [
    "<string>"
  ],
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "active",
  "updated_at": "2023-11-07T05:31:56Z",
  "url": "<string>",
  "description": "<string>",
  "disabled_reason": "<string>",
  "previous_secret_expires_at": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "retry_at": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "retry_at": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "retry_at": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "retry_at": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "retry_at": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "retry_at": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "retry_at": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "retry_at": "2023-11-07T05:31:56Z"
}

Authorizations

lx_session

string

required

Dashboard session cookie

Path Parameters

string<uuid>

required

Body

application/json

description

string

Maximum string length: 500

event_types

enum<string>[]

Minimum array length: 1

Available options:

call.started,

call.answered,

call.ended,

call.analyzed,

call.recording.ready,

call.transferred,

campaign.started,

campaign.paused,

campaign.completed,

campaign.contact.completed,

compliance.opt_out,

billing.balance.low,

billing.top_up.succeeded,

billing.auto_top_up.failed,

number.provisioned,

number.released

status

enum<string>

Available options:

active,

disabled

url

string<uri>

Maximum string length: 2000

Response

consecutive_failures

integer<int64>

required

created_at

string<date-time>

required

event_types

string[]

required

string<uuid>

required

status

enum<string>

required

Available options:

active,

disabled

updated_at

string<date-time>

required

url

string<uri>

required

description

string

disabled_reason

string

previous_secret_expires_at

string<date-time>

⌘I

Update a webhook endpoint

curl --request PATCH \
  --url https://api-us.larynth.com/v1/webhooks/{id} \
  --header 'Content-Type: application/json' \
  --cookie lx_session= \
  --data '
{
  "description": "<string>",
  "event_types": [],
  "url": "<string>"
}
'

import requests

url = "https://api-us.larynth.com/v1/webhooks/{id}"

payload = {
    "description": "<string>",
    "event_types": [],
    "url": "<string>"
}
headers = {
    "cookie": "lx_session=",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {cookie: 'lx_session=', 'Content-Type': 'application/json'},
  body: JSON.stringify({description: '<string>', event_types: [], url: '<string>'})
};

fetch('https://api-us.larynth.com/v1/webhooks/{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://api-us.larynth.com/v1/webhooks/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => '<string>',
    'event_types' => [
        
    ],
    'url' => '<string>'
  ]),
  CURLOPT_COOKIE => "lx_session=",
  CURLOPT_HTTPHEADER => [
    "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://api-us.larynth.com/v1/webhooks/{id}"

	payload := strings.NewReader("{\n  \"description\": \"<string>\",\n  \"event_types\": [],\n  \"url\": \"<string>\"\n}")

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

	req.Header.Add("cookie", "lx_session=")
	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.patch("https://api-us.larynth.com/v1/webhooks/{id}")
  .header("cookie", "lx_session=")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"<string>\",\n  \"event_types\": [],\n  \"url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-us.larynth.com/v1/webhooks/{id}")

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

request = Net::HTTP::Patch.new(url)
request["cookie"] = 'lx_session='
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"<string>\",\n  \"event_types\": [],\n  \"url\": \"<string>\"\n}"

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

{
  "consecutive_failures": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "event_types": [
    "<string>"
  ],
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "active",
  "updated_at": "2023-11-07T05:31:56Z",
  "url": "<string>",
  "description": "<string>",
  "disabled_reason": "<string>",
  "previous_secret_expires_at": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "retry_at": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "retry_at": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "retry_at": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "retry_at": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "retry_at": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "retry_at": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "retry_at": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "retry_at": "2023-11-07T05:31:56Z"
}

Overview

Assistants

Calls

Recordings

Campaigns

Contacts

Compliance

Phone numbers

Knowledge bases

Billing

Catalog

Webhook endpoints

Update a webhook endpoint

Authorizations

Path Parameters

Body

Response