List webhooks

curl --request GET \
  --url https://api.b2bsignals.ai/api/v1/webhooks/ \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.b2bsignals.ai/api/v1/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.b2bsignals.ai/api/v1/webhooks/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.b2bsignals.ai/api/v1/webhooks/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.b2bsignals.ai/api/v1/webhooks/")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

[
  {
    "name": "<string>",
    "url": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "is_active": true,
    "event_types": [
      "lead.created",
      "lead.enriched",
      "invitation_accepted",
      "message_replied",
      "workflow_completed"
    ],
    "workflow_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "last_delivery": {
      "at": "2023-11-07T05:31:56Z",
      "ok": true,
      "status_code": 123,
      "error": "<string>"
    },
    "consecutive_failures": 0,
    "state": "never_sent",
    "status": "never_sent",
    "stopped_at": "2023-11-07T05:31:56Z",
    "retrying": 0,
    "secret_last4": "<string>",
    "secret_masked": "<string>",
    "retries": {
      "max_retries": 123,
      "within_minutes": 123,
      "text": "<string>"
    },
    "url_masked": false,
    "campaigns": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "kind": "<string>"
      }
    ],
    "sources": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "kind": "<string>"
      }
    ]
  }
]

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

GET

webhooks

List webhooks

curl --request GET \
  --url https://api.b2bsignals.ai/api/v1/webhooks/ \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.b2bsignals.ai/api/v1/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.b2bsignals.ai/api/v1/webhooks/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.b2bsignals.ai/api/v1/webhooks/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.b2bsignals.ai/api/v1/webhooks/")

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

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

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

[
  {
    "name": "<string>",
    "url": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "is_active": true,
    "event_types": [
      "lead.created",
      "lead.enriched",
      "invitation_accepted",
      "message_replied",
      "workflow_completed"
    ],
    "workflow_ids": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "last_delivery": {
      "at": "2023-11-07T05:31:56Z",
      "ok": true,
      "status_code": 123,
      "error": "<string>"
    },
    "consecutive_failures": 0,
    "state": "never_sent",
    "status": "never_sent",
    "stopped_at": "2023-11-07T05:31:56Z",
    "retrying": 0,
    "secret_last4": "<string>",
    "secret_masked": "<string>",
    "retries": {
      "max_retries": 123,
      "within_minutes": 123,
      "text": "<string>"
    },
    "url_masked": false,
    "campaigns": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "kind": "<string>"
      }
    ],
    "sources": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "kind": "<string>"
      }
    ]
  }
]

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Your workspace's API key. It starts with b2b_sk_.

Query Parameters

skip

integer

default:0

How many rows to skip. Starts at 0.

Required range: x >= 0

limit

integer

default:50

How many rows to return in one page.

Required range: 1 <= x <= 200

workflow_id

string<uuid> | null

Only this campaign.

include_all_campaigns

boolean

default:false

Response

Success

name

string

required

url

string

required

string<uuid>

required

created_at

string<date-time>

required

updated_at

string<date-time>

required

is_active

boolean

default:true

event_types

string[]

workflow_ids

string<uuid>[] | null

last_delivery

object | null

Show child attributes

consecutive_failures

integer

default:0

state

enum<string>

default:never_sent

Available options:

working,

failing,

never_sent

status

enum<string>

default:never_sent

Available options:

working,

not_working,

never_sent

stopped_at

string<date-time> | null

retrying

integer

default:0

secret_last4

string | null

secret_masked

string | null

retries

object | null

Show child attributes

url_masked

boolean

default:false

campaigns

object[]

Show child attributes

sources

object[]

Show child attributes

Build on B2B Signals

API reference

List webhooks

Authorizations

Query Parameters

Response