Webhooks

Register a webhook endpoint

Register an https:// address on your server. Each time a supplier replies to one of your requests for quote, an address bounces, or a search or a comparison ends, we send that address a signed event naming the request, the search or the comparison, so you read it with GET /v1/rfq/{id}, GET /v1/search/{id} or GET /v1/compare/{id} instead of polling. The response carries the endpoint’s signing secret, the only time it is shown: store it, and check the webhook-signature header of every event with it. An endpoint registered with one of your organization’s own keys receives every event of your organization; one registered with a key you created for one of your customers (POST /v1/keys) receives only that customer’s events.

POST

webhooks

curl --request POST \
  --url https://api.partfinder.dev/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://api.example.com/hooks/partfinder"
}
'

import requests

url = "https://api.partfinder.dev/v1/webhooks"

payload = { "url": "https://api.example.com/hooks/partfinder" }
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({url: 'https://api.example.com/hooks/partfinder'})
};

fetch('https://api.partfinder.dev/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.partfinder.dev/v1/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([
    'url' => 'https://api.example.com/hooks/partfinder'
  ]),
  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://api.partfinder.dev/v1/webhooks"

	payload := strings.NewReader("{\n  \"url\": \"https://api.example.com/hooks/partfinder\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.partfinder.dev/v1/webhooks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://api.example.com/hooks/partfinder\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.partfinder.dev/v1/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  \"url\": \"https://api.example.com/hooks/partfinder\"\n}"

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

{
  "as_of": "2026-10-07T09:20:11.455Z",
  "summary": "Events for your requests for quote, searches and comparisons will be sent to https://api.example.com/hooks/partfinder. Store the secret now: it is not shown again.",
  "notice": "Informational only. Risk scores, stock levels, lead times and alternate-part suggestions may be incomplete, delayed or inaccurate. Independently verify before making procurement, engineering, compliance, safety or sourcing decisions.",
  "endpoint": {
    "id": "9c41e7a2-5d3b-4f0e-8a16-2b7d94c0e5f1",
    "url": "https://api.example.com/hooks/partfinder",
    "created_at": "2026-10-07T09:20:11.402Z"
  },
  "secret": "whsec_EXAMPLEdoNOTuseEXAMPLEdoNOTuseEXAMPLEdoNOTuse0="
}

{
  "error": "authentication_required",
  "summary": "<string>",
  "reason": "<string>",
  "billing_url": "<string>",
  "did_you_mean": [
    "<string>"
  ]
}

{
  "error": "authentication_required",
  "summary": "<string>",
  "reason": "<string>",
  "billing_url": "<string>",
  "did_you_mean": [
    "<string>"
  ]
}

{
  "error": "authentication_required",
  "summary": "<string>",
  "reason": "<string>",
  "billing_url": "<string>",
  "did_you_mean": [
    "<string>"
  ]
}

{
  "error": "authentication_required",
  "summary": "<string>",
  "reason": "<string>",
  "billing_url": "<string>",
  "did_you_mean": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

An API key created in the PartFinder console at https://console.partfinder.dev, or a customer key created with POST /v1/keys. Send as Authorization: Bearer <key>. Revocation takes effect within approximately one minute.

Body

application/json

url

string<uri>

required

The https:// address on your server that receives the events. It must be on the public internet.

Response

Registered. Store secret now: it is not shown again.

as_of

string<date-time>

required

ISO 8601. How current the data in this response is.

summary

string

required

Plain language an agent can relay without re-deriving it.

notice

string

required

Informational-use notice. Always present.

endpoint

object

required

Show child attributes

secret

string

required

The signing secret for this endpoint, shown only in this response: store it now. Use it to check the webhook-signature header of every event we send, as the Standard Webhooks libraries do. It signs our messages and gives no access to the API.

curl --request POST \
  --url https://api.partfinder.dev/v1/webhooks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://api.example.com/hooks/partfinder"
}
'

import requests

url = "https://api.partfinder.dev/v1/webhooks"

payload = { "url": "https://api.example.com/hooks/partfinder" }
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({url: 'https://api.example.com/hooks/partfinder'})
};

fetch('https://api.partfinder.dev/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.partfinder.dev/v1/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([
    'url' => 'https://api.example.com/hooks/partfinder'
  ]),
  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://api.partfinder.dev/v1/webhooks"

	payload := strings.NewReader("{\n  \"url\": \"https://api.example.com/hooks/partfinder\"\n}")

	req, _ := http.NewRequest("POST", 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.post("https://api.partfinder.dev/v1/webhooks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://api.example.com/hooks/partfinder\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.partfinder.dev/v1/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  \"url\": \"https://api.example.com/hooks/partfinder\"\n}"

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

{
  "as_of": "2026-10-07T09:20:11.455Z",
  "summary": "Events for your requests for quote, searches and comparisons will be sent to https://api.example.com/hooks/partfinder. Store the secret now: it is not shown again.",
  "notice": "Informational only. Risk scores, stock levels, lead times and alternate-part suggestions may be incomplete, delayed or inaccurate. Independently verify before making procurement, engineering, compliance, safety or sourcing decisions.",
  "endpoint": {
    "id": "9c41e7a2-5d3b-4f0e-8a16-2b7d94c0e5f1",
    "url": "https://api.example.com/hooks/partfinder",
    "created_at": "2026-10-07T09:20:11.402Z"
  },
  "secret": "whsec_EXAMPLEdoNOTuseEXAMPLEdoNOTuseEXAMPLEdoNOTuse0="
}

{
  "error": "authentication_required",
  "summary": "<string>",
  "reason": "<string>",
  "billing_url": "<string>",
  "did_you_mean": [
    "<string>"
  ]
}

{
  "error": "authentication_required",
  "summary": "<string>",
  "reason": "<string>",
  "billing_url": "<string>",
  "did_you_mean": [
    "<string>"
  ]
}

{
  "error": "authentication_required",
  "summary": "<string>",
  "reason": "<string>",
  "billing_url": "<string>",
  "did_you_mean": [
    "<string>"
  ]
}

{
  "error": "authentication_required",
  "summary": "<string>",
  "reason": "<string>",
  "billing_url": "<string>",
  "did_you_mean": [
    "<string>"
  ]
}

Overview

Endpoints

Register a webhook endpoint

Authorizations

Body

Response