Skip to main content
POST
/
api
/
v2
/
webhooks
Create webhook
curl --request POST \
  --url https://api.example.com/api/v2/webhooks \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "url": "<string>",
  "eventTypes": [
    "<string>"
  ],
  "monitoredAccountIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "token": "<string>",
  "signingToken": "<string>",
  "username": "<string>",
  "password": "<string>"
}
'
import requests

url = "https://api.example.com/api/v2/webhooks"

payload = {
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"url": "<string>",
"eventTypes": ["<string>"],
"monitoredAccountIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"token": "<string>",
"signingToken": "<string>",
"username": "<string>",
"password": "<string>"
}
headers = {"Content-Type": "application/json"}

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

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
workspaceId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
name: '<string>',
url: '<string>',
eventTypes: ['<string>'],
monitoredAccountIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
token: '<string>',
signingToken: '<string>',
username: '<string>',
password: '<string>'
})
};

fetch('https://api.example.com/api/v2/webhooks', 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.example.com/api/v2/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'workspaceId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'name' => '<string>',
'url' => '<string>',
'eventTypes' => [
'<string>'
],
'monitoredAccountIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'token' => '<string>',
'signingToken' => '<string>',
'username' => '<string>',
'password' => '<string>'
]),
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.example.com/api/v2/webhooks"

payload := strings.NewReader("{\n \"workspaceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"eventTypes\": [\n \"<string>\"\n ],\n \"monitoredAccountIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"token\": \"<string>\",\n \"signingToken\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\"\n}")

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

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.post("https://api.example.com/api/v2/webhooks")
.header("Content-Type", "application/json")
.body("{\n \"workspaceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"eventTypes\": [\n \"<string>\"\n ],\n \"monitoredAccountIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"token\": \"<string>\",\n \"signingToken\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v2/webhooks")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"workspaceId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"eventTypes\": [\n \"<string>\"\n ],\n \"monitoredAccountIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"token\": \"<string>\",\n \"signingToken\": \"<string>\",\n \"username\": \"<string>\",\n \"password\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "secret": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "serviceProviderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "targetAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "targetAccountName": "<string>",
    "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "url": "<string>",
    "eventTypes": [
      "<string>"
    ],
    "monitoredAccountIds": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "hasSigningToken": true,
    "disableReason": "<string>",
    "disabledAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "lastModifiedAt": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "requestId": "<string>",
    "timestamp": "<string>"
  }
}
{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}
{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}
{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}
{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}
{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}

Body

application/json
workspaceId
null | string<uuid>
name
null | string
url
null | string
eventTypes
null | string[]
monitoredAccountIds
null | string<uuid>[]
authenticationType
enum<string>
Available options:
None,
BasicAuth,
BearerToken
token
null | string
signingToken
null | string
username
null | string
password
null | string

Response

Created

Standard v2 API response envelope for single-item responses.

data
object
meta
object