Remove Triggers

curl --request DELETE \
  --url https://apimgmt.cometchat.io/apps/{appId}/webhooks/{webhookId}/triggers \
  --header 'Content-Type: application/json' \
  --header 'key: <key>' \
  --header 'secret: <secret>' \
  --data '
{
  "name": "Example User",
  "email": "my-email@example.com",
  "password": "somePassword#!",
  "contactNumber": "+12125550123",
  "role": "engineer",
  "appName": "Create APP",
  "appRegion": "us"
}
'

import requests

url = "https://apimgmt.cometchat.io/apps/{appId}/webhooks/{webhookId}/triggers"

payload = {
    "name": "Example User",
    "email": "my-email@example.com",
    "password": "somePassword#!",
    "contactNumber": "+12125550123",
    "role": "engineer",
    "appName": "Create APP",
    "appRegion": "us"
}
headers = {
    "key": "<key>",
    "secret": "<secret>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'DELETE',
  headers: {key: '<key>', secret: '<secret>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Example User',
    email: 'my-email@example.com',
    password: 'somePassword#!',
    contactNumber: '+12125550123',
    role: 'engineer',
    appName: 'Create APP',
    appRegion: 'us'
  })
};

fetch('https://apimgmt.cometchat.io/apps/{appId}/webhooks/{webhookId}/triggers', 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://apimgmt.cometchat.io/apps/{appId}/webhooks/{webhookId}/triggers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Example User',
    'email' => 'my-email@example.com',
    'password' => 'somePassword#!',
    'contactNumber' => '+12125550123',
    'role' => 'engineer',
    'appName' => 'Create APP',
    'appRegion' => 'us'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "key: <key>",
    "secret: <secret>"
  ],
]);

$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://apimgmt.cometchat.io/apps/{appId}/webhooks/{webhookId}/triggers"

	payload := strings.NewReader("{\n  \"name\": \"Example User\",\n  \"email\": \"my-email@example.com\",\n  \"password\": \"somePassword#!\",\n  \"contactNumber\": \"+12125550123\",\n  \"role\": \"engineer\",\n  \"appName\": \"Create APP\",\n  \"appRegion\": \"us\"\n}")

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

	req.Header.Add("key", "<key>")
	req.Header.Add("secret", "<secret>")
	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.delete("https://apimgmt.cometchat.io/apps/{appId}/webhooks/{webhookId}/triggers")
  .header("key", "<key>")
  .header("secret", "<secret>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Example User\",\n  \"email\": \"my-email@example.com\",\n  \"password\": \"somePassword#!\",\n  \"contactNumber\": \"+12125550123\",\n  \"role\": \"engineer\",\n  \"appName\": \"Create APP\",\n  \"appRegion\": \"us\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apimgmt.cometchat.io/apps/{appId}/webhooks/{webhookId}/triggers")

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

request = Net::HTTP::Delete.new(url)
request["key"] = '<key>'
request["secret"] = '<secret>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Example User\",\n  \"email\": \"my-email@example.com\",\n  \"password\": \"somePassword#!\",\n  \"contactNumber\": \"+12125550123\",\n  \"role\": \"engineer\",\n  \"appName\": \"Create APP\",\n  \"appRegion\": \"us\"\n}"

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

{
  "data": {
    "success": true,
    "message": "Removed trigger successfully."
  }
}

DELETE

apps

{appId}

webhooks

{webhookId}

triggers

Remove Triggers

curl --request DELETE \
  --url https://apimgmt.cometchat.io/apps/{appId}/webhooks/{webhookId}/triggers \
  --header 'Content-Type: application/json' \
  --header 'key: <key>' \
  --header 'secret: <secret>' \
  --data '
{
  "name": "Example User",
  "email": "my-email@example.com",
  "password": "somePassword#!",
  "contactNumber": "+12125550123",
  "role": "engineer",
  "appName": "Create APP",
  "appRegion": "us"
}
'

import requests

url = "https://apimgmt.cometchat.io/apps/{appId}/webhooks/{webhookId}/triggers"

payload = {
    "name": "Example User",
    "email": "my-email@example.com",
    "password": "somePassword#!",
    "contactNumber": "+12125550123",
    "role": "engineer",
    "appName": "Create APP",
    "appRegion": "us"
}
headers = {
    "key": "<key>",
    "secret": "<secret>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'DELETE',
  headers: {key: '<key>', secret: '<secret>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Example User',
    email: 'my-email@example.com',
    password: 'somePassword#!',
    contactNumber: '+12125550123',
    role: 'engineer',
    appName: 'Create APP',
    appRegion: 'us'
  })
};

fetch('https://apimgmt.cometchat.io/apps/{appId}/webhooks/{webhookId}/triggers', 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://apimgmt.cometchat.io/apps/{appId}/webhooks/{webhookId}/triggers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "DELETE",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Example User',
    'email' => 'my-email@example.com',
    'password' => 'somePassword#!',
    'contactNumber' => '+12125550123',
    'role' => 'engineer',
    'appName' => 'Create APP',
    'appRegion' => 'us'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "key: <key>",
    "secret: <secret>"
  ],
]);

$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://apimgmt.cometchat.io/apps/{appId}/webhooks/{webhookId}/triggers"

	payload := strings.NewReader("{\n  \"name\": \"Example User\",\n  \"email\": \"my-email@example.com\",\n  \"password\": \"somePassword#!\",\n  \"contactNumber\": \"+12125550123\",\n  \"role\": \"engineer\",\n  \"appName\": \"Create APP\",\n  \"appRegion\": \"us\"\n}")

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

	req.Header.Add("key", "<key>")
	req.Header.Add("secret", "<secret>")
	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.delete("https://apimgmt.cometchat.io/apps/{appId}/webhooks/{webhookId}/triggers")
  .header("key", "<key>")
  .header("secret", "<secret>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Example User\",\n  \"email\": \"my-email@example.com\",\n  \"password\": \"somePassword#!\",\n  \"contactNumber\": \"+12125550123\",\n  \"role\": \"engineer\",\n  \"appName\": \"Create APP\",\n  \"appRegion\": \"us\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://apimgmt.cometchat.io/apps/{appId}/webhooks/{webhookId}/triggers")

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

request = Net::HTTP::Delete.new(url)
request["key"] = '<key>'
request["secret"] = '<secret>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Example User\",\n  \"email\": \"my-email@example.com\",\n  \"password\": \"somePassword#!\",\n  \"contactNumber\": \"+12125550123\",\n  \"role\": \"engineer\",\n  \"appName\": \"Create APP\",\n  \"appRegion\": \"us\"\n}"

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

{
  "data": {
    "success": true,
    "message": "Removed trigger successfully."
  }
}

For the complete error reference, see Error Guide.

Headers

key

string

required

Authorization Key

secret

string

required

Authorization Secret

X-Webhook-Version

integer

The "X-Webhook-Version" header is an optional integer property.When this header is omitted from the request, the system defaults to the legacy webhook, ensuring backward compatibility and seamless operation.Conversely, setting the value of this header to "2" indicates the preference for the new webhook implementation.

Path Parameters

appId

string

required

AppID in which the extension has to be enabled/disabled

webhookId

string

required

Id of the webhook

Body

application/json

triggerIds

string[]

array of triggerIds.

Response

200 - application/json

Enabled Triggers

data

object

Show child attributes

Chat APIs

Management APIs (Multi-Tenancy)

Remove Triggers

Headers

Path Parameters

Body

Response