Update a webhook endpoint

curl --request PATCH \
  --url https://lazyapp.in/v1/webhooks/{webhook} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "description": "<string>",
  "subscribed_events": [],
  "custom_headers": {},
  "phone_number_restrictions": [
    "<string>"
  ],
  "timeout_seconds": 15,
  "max_attempts": 4
}
'

import requests

url = "https://lazyapp.in/v1/webhooks/{webhook}"

payload = {
    "url": "<string>",
    "description": "<string>",
    "subscribed_events": [],
    "custom_headers": {},
    "phone_number_restrictions": ["<string>"],
    "timeout_seconds": 15,
    "max_attempts": 4
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: '<string>',
    description: '<string>',
    subscribed_events: [],
    custom_headers: {},
    phone_number_restrictions: ['<string>'],
    timeout_seconds: 15,
    max_attempts: 4
  })
};

fetch('https://lazyapp.in/v1/webhooks/{webhook}', 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://lazyapp.in/v1/webhooks/{webhook}",
  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([
    'url' => '<string>',
    'description' => '<string>',
    'subscribed_events' => [
        
    ],
    'custom_headers' => [
        
    ],
    'phone_number_restrictions' => [
        '<string>'
    ],
    'timeout_seconds' => 15,
    'max_attempts' => 4
  ]),
  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://lazyapp.in/v1/webhooks/{webhook}"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"description\": \"<string>\",\n  \"subscribed_events\": [],\n  \"custom_headers\": {},\n  \"phone_number_restrictions\": [\n    \"<string>\"\n  ],\n  \"timeout_seconds\": 15,\n  \"max_attempts\": 4\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://lazyapp.in/v1/webhooks/{webhook}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"<string>\",\n  \"description\": \"<string>\",\n  \"subscribed_events\": [],\n  \"custom_headers\": {},\n  \"phone_number_restrictions\": [\n    \"<string>\"\n  ],\n  \"timeout_seconds\": 15,\n  \"max_attempts\": 4\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://lazyapp.in/v1/webhooks/{webhook}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"<string>\",\n  \"description\": \"<string>\",\n  \"subscribed_events\": [],\n  \"custom_headers\": {},\n  \"phone_number_restrictions\": [\n    \"<string>\"\n  ],\n  \"timeout_seconds\": 15,\n  \"max_attempts\": 4\n}"

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

{
  "id": 123,
  "url": "<string>",
  "description": "<string>",
  "is_active": true,
  "subscribed_events": [
    "message.received"
  ],
  "custom_headers": {},
  "phone_number_restrictions": [
    "<string>"
  ],
  "timeout_seconds": 123,
  "max_attempts": 123,
  "api_version": "<string>",
  "consecutive_failures": 123,
  "paused_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "pause_reason": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "errors": {}
}

{
  "message": "<string>",
  "code": "<string>"
}

PATCH

webhooks

{webhook}

Update a webhook endpoint

curl --request PATCH \
  --url https://lazyapp.in/v1/webhooks/{webhook} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "description": "<string>",
  "subscribed_events": [],
  "custom_headers": {},
  "phone_number_restrictions": [
    "<string>"
  ],
  "timeout_seconds": 15,
  "max_attempts": 4
}
'

import requests

url = "https://lazyapp.in/v1/webhooks/{webhook}"

payload = {
    "url": "<string>",
    "description": "<string>",
    "subscribed_events": [],
    "custom_headers": {},
    "phone_number_restrictions": ["<string>"],
    "timeout_seconds": 15,
    "max_attempts": 4
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: '<string>',
    description: '<string>',
    subscribed_events: [],
    custom_headers: {},
    phone_number_restrictions: ['<string>'],
    timeout_seconds: 15,
    max_attempts: 4
  })
};

fetch('https://lazyapp.in/v1/webhooks/{webhook}', 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://lazyapp.in/v1/webhooks/{webhook}",
  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([
    'url' => '<string>',
    'description' => '<string>',
    'subscribed_events' => [
        
    ],
    'custom_headers' => [
        
    ],
    'phone_number_restrictions' => [
        '<string>'
    ],
    'timeout_seconds' => 15,
    'max_attempts' => 4
  ]),
  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://lazyapp.in/v1/webhooks/{webhook}"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"description\": \"<string>\",\n  \"subscribed_events\": [],\n  \"custom_headers\": {},\n  \"phone_number_restrictions\": [\n    \"<string>\"\n  ],\n  \"timeout_seconds\": 15,\n  \"max_attempts\": 4\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://lazyapp.in/v1/webhooks/{webhook}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"<string>\",\n  \"description\": \"<string>\",\n  \"subscribed_events\": [],\n  \"custom_headers\": {},\n  \"phone_number_restrictions\": [\n    \"<string>\"\n  ],\n  \"timeout_seconds\": 15,\n  \"max_attempts\": 4\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://lazyapp.in/v1/webhooks/{webhook}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"<string>\",\n  \"description\": \"<string>\",\n  \"subscribed_events\": [],\n  \"custom_headers\": {},\n  \"phone_number_restrictions\": [\n    \"<string>\"\n  ],\n  \"timeout_seconds\": 15,\n  \"max_attempts\": 4\n}"

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

{
  "id": 123,
  "url": "<string>",
  "description": "<string>",
  "is_active": true,
  "subscribed_events": [
    "message.received"
  ],
  "custom_headers": {},
  "phone_number_restrictions": [
    "<string>"
  ],
  "timeout_seconds": 123,
  "max_attempts": 123,
  "api_version": "<string>",
  "consecutive_failures": 123,
  "paused_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "pause_reason": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "code": "<string>"
}

{
  "message": "<string>",
  "errors": {}
}

{
  "message": "<string>",
  "code": "<string>"
}

Authorizations

Authorization

string

header

required

Your API key, e.g. sk_live_... or sk_test_....

Headers

Idempotency-Key

string

Optional. Makes this write safe to retry: the same key replays the first response instead of acting twice.

Maximum string length: 255

Path Parameters

webhook

string

required

Endpoint id.

Body

application/json

url

string

Must be https.

Maximum string length: 2048

description

string | null

Maximum string length: 255

subscribed_events

enum<string>[] | null

Replaces the list. null or [] subscribes to every event.

Available options:

message.received,

message.queued,

message.sent,

message.delivered,

message.read,

message.played,

message.failed,

message.deleted,

message.edited,

message.echo,

reaction.received,

conversation.started,

commerce.order,

payment.captured,

payment.failed,

payment.refunded,

payment.order_status_updated,

template.pending,

template.approved,

template.rejected,

template.paused,

template.disabled,

template.category_changed,

template.quality_changed,

template.updated,

template.deleted,

marketing.link_clicked,

otp.requested,

otp.verified,

otp.failed,

contact.updated,

contact.opted_in,

contact.opted_out,

phone_number.updated,

phone_number.quality_changed,

connection.connected,

connection.attention_required,

connection.disconnected,

account.updated,

flow.published,

flow.failed,

flow.response_received,

flow.status_changed,

workflow.started,

workflow.completed,

workflow.failed,

campaign.started,

campaign.completed,

campaign.failed,

call.received,

call.ended,

call.failed,

call.permission_request,

call.recording_available,

call.transcript_available,

conversion.detected,

customer.created,

customer.updated,

customer.suspended,

customer.archived,

customer.deleted,

customer.connected,

customer.usage_alert,

setup_link.failed,

address.received,

contact.identity_changed,

group.created,

group.updated,

group.deleted,

group.participants_changed,

group.join_requested,

group.suspended

custom_headers

object | null

Show child attributes

phone_number_restrictions

string[] | null

Replaces the list. null delivers events from every number.

Maximum array length: 50

Maximum string length: 64

timeout_seconds

integer

Required range: 1 <= x <= 30

max_attempts

integer

Delivery attempts before an event is given up. Defaults to 3.

Required range: 1 <= x <= 8

Response

The updated endpoint. The secret is not included.

integer

url

string

description

string | null

is_active

boolean

subscribed_events

enum<string>[]

Empty means every event.

Available options:

message.received,

message.queued,

message.sent,

message.delivered,

message.read,

message.played,

message.failed,

message.deleted,

message.edited,

message.echo,

reaction.received,

conversation.started,

commerce.order,

payment.captured,

payment.failed,

payment.refunded,

payment.order_status_updated,

template.pending,

template.approved,

template.rejected,

template.paused,

template.disabled,

template.category_changed,

template.quality_changed,

template.updated,

template.deleted,

marketing.link_clicked,

otp.requested,

otp.verified,

otp.failed,

contact.updated,

contact.opted_in,

contact.opted_out,

phone_number.updated,

phone_number.quality_changed,

connection.connected,

connection.attention_required,

connection.disconnected,

account.updated,

flow.published,

flow.failed,

flow.response_received,

flow.status_changed,

workflow.started,

workflow.completed,

workflow.failed,

campaign.started,

campaign.completed,

campaign.failed,

call.received,

call.ended,

call.failed,

call.permission_request,

call.recording_available,

call.transcript_available,

conversion.detected,

customer.created,

customer.updated,

customer.suspended,

customer.archived,

customer.deleted,

customer.connected,

customer.usage_alert,

setup_link.failed,

address.received,

contact.identity_changed,

group.created,

group.updated,

group.deleted,

group.participants_changed,

group.join_requested,

group.suspended

custom_headers

object

phone_number_restrictions

string[]

timeout_seconds

integer

max_attempts

integer

api_version

string

consecutive_failures

integer

paused_at

string<date-time> | null

Set when repeated failures auto-paused the endpoint.

created_at

string<date-time> | null

pause_reason

string | null

Why deliveries stopped. Set when LazyApp auto-paused the endpoint after repeated failures.

Messages

Contacts

Conversations

Calls

Groups

Templates

Media

Broadcasts

Events

Flows

Webhooks

Workflows

Verify

Capabilities

Catalog

Funding

Platform

Meta-compatible proxy

Connections

Billing

Analytics

Payments

Update a webhook endpoint

Authorizations

Headers

Path Parameters

Body

Response