Search

Search for webhook subscriptions by query string or specific webhook references.

POST /api/v1/search/webhooks

Search

Go

package main

import(
	"context"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := conductoronesdkgo.New(
        conductoronesdkgo.WithSecurity(shared.Security{
            BearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
            Oauth: "<YOUR_OAUTH_HERE>",
        }),
    )

    res, err := s.WebhooksSearch.Search(ctx, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.WebhooksSearchResponse != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";

const conductoroneSDKTypescript = new ConductoroneSDKTypescript({
  security: {
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
    oauth: "<YOUR_OAUTH_HERE>",
  },
});

async function run() {
  const result = await conductoroneSDKTypescript.webhooksSearch.search();

  for await (const page of result) {
    console.log(page);
  }
}

run();

curl --request POST \
  --url https://{tenantDomain}.conductor.one/api/v1/search/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pageSize": 123,
  "pageToken": "<string>",
  "query": "<string>",
  "refs": [
    {
      "id": "<string>"
    }
  ]
}
'

import requests

url = "https://{tenantDomain}.conductor.one/api/v1/search/webhooks"

payload = {
    "pageSize": 123,
    "pageToken": "<string>",
    "query": "<string>",
    "refs": [{ "id": "<string>" }]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    pageSize: 123,
    pageToken: '<string>',
    query: '<string>',
    refs: [{id: '<string>'}]
  })
};

fetch('https://{tenantDomain}.conductor.one/api/v1/search/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://{tenantDomain}.conductor.one/api/v1/search/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([
    'pageSize' => 123,
    'pageToken' => '<string>',
    'query' => '<string>',
    'refs' => [
        [
                'id' => '<string>'
        ]
    ]
  ]),
  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;
}

HttpResponse<String> response = Unirest.post("https://{tenantDomain}.conductor.one/api/v1/search/webhooks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"pageSize\": 123,\n  \"pageToken\": \"<string>\",\n  \"query\": \"<string>\",\n  \"refs\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}.conductor.one/api/v1/search/webhooks")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"pageSize\": 123,\n  \"pageToken\": \"<string>\",\n  \"query\": \"<string>\",\n  \"refs\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ]\n}"

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

200

{
  "list": [
    {
      "callbackTimeout": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "displayName": "<string>",
      "id": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "url": "<string>"
    }
  ],
  "nextPageToken": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization · string · header · required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Body

application/json

The WebhooksSearchRequest message.

pageSize · integer<int32> | null

The maximum number of webhooks to return per page.

pageToken · string | null

The pagination token from a previous search response to fetch the next page.

query · string | null

A text query to match against webhook names and descriptions.

refs · Webhook Ref · object[] | null

Optional set of webhook references to restrict the search to specific webhooks.

Show child attributes

Response

200 - application/json

Successful response

The WebhooksSearchResponse message.

list · Webhook · object[] | null

The list of webhooks matching the search criteria.

Show child attributes

nextPageToken · string | null

A token to retrieve the next page of results, or empty if there are no more results.