Add a webhook endpoint

POST

/v1/webhooks

#!/usr/bin/env bash
set -euo pipefail
API=https://api.speccapture.com
AUTH="Authorization: Bearer $SPECCAPTURE_API_KEY"

webhook=$(curl -sS --fail-with-body "$API/v1/webhooks" \
  -H "$AUTH" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://erp.example.com/hooks/speccapture","description":"ERP import"}') || { echo "$webhook" >&2; exit 1; }
jq -r '"Endpoint \(.webhookId)"' <<<"$webhook"
jq -r '"Signing secret, shown this once: \(.signingSecret)"' <<<"$webhook"

using System.Text;
using System.Text.Json;
using System.Text.Json.Nodes;

using HttpClient http = new() { BaseAddress = new Uri("https://api.speccapture.com") };
http.DefaultRequestHeaders.Authorization = new("Bearer", Environment.GetEnvironmentVariable("SPECCAPTURE_API_KEY"));

StringContent body = new(new JsonObject {
    ["url"] = "https://erp.example.com/hooks/speccapture",
    ["description"] = "ERP import",
}.ToJsonString(), Encoding.UTF8, "application/json");
JsonElement webhook = await Json(await Call(HttpMethod.Post, "/v1/webhooks", body));
Console.WriteLine($"Endpoint {webhook.GetProperty("webhookId")}");
Console.WriteLine($"Signing secret, shown this once: {webhook.GetProperty("signingSecret")}");

// Sends a request; stops with the problem's code and detail if the API refuses it.
async Task<HttpResponseMessage> Call(HttpMethod method, string path, HttpContent? body = null, string? idempotencyKey = null) {
    using HttpRequestMessage request = new(method, path) { Content = body };
    if (idempotencyKey is not null) request.Headers.Add("Idempotency-Key", idempotencyKey);
    HttpResponseMessage response = await http.SendAsync(request);
    if (!response.IsSuccessStatusCode) {
        JsonElement problem = await Json(response);
        string? detail = (problem.TryGetProperty("detail", out JsonElement text) ? text : problem.GetProperty("title")).GetString();
        Console.Error.WriteLine($"{(int)response.StatusCode} {problem.GetProperty("code")}: {detail}");
        Environment.Exit(1);
    }
    return response;
}

// Reads an answer as JSON.
static async Task<JsonElement> Json(HttpResponseMessage response) =>
    JsonDocument.Parse(await response.Content.ReadAsStringAsync()).RootElement;

import os
import sys

import requests

API = "https://api.speccapture.com"
session = requests.Session()
session.headers["Authorization"] = f"Bearer {os.environ['SPECCAPTURE_API_KEY']}"


def call(method, path, **kwargs):
    """Send a request; stop with the problem's code and detail if the API refuses it."""
    response = session.request(method, API + path, **kwargs)
    if not response.ok:
        problem = response.json()
        sys.exit(f"{response.status_code} {problem['code']}: {problem.get('detail', problem['title'])}")
    return response


webhook = call(
    "POST",
    "/v1/webhooks",
    json={"url": "https://erp.example.com/hooks/speccapture", "description": "ERP import"},
).json()
print(f"Endpoint {webhook['webhookId']}")
print(f"Signing secret, shown this once: {webhook['signingSecret']}")

const API = "https://api.speccapture.com";
const headers = { Authorization: `Bearer ${process.env.SPECCAPTURE_API_KEY}` };

const webhook = await call("POST", "/v1/webhooks", {
  body: JSON.stringify({ url: "https://erp.example.com/hooks/speccapture", description: "ERP import" }),
  headers: { "Content-Type": "application/json" },
}).then((response) => response.json());
console.log(`Endpoint ${webhook.webhookId}`);
console.log(`Signing secret, shown this once: ${webhook.signingSecret}`);

// Sends a request; stops with the problem's code and detail if the API refuses it.
async function call(method, path, init = {}) {
  const response = await fetch(API + path, { ...init, method, headers: { ...headers, ...init.headers } });
  if (!response.ok) {
    const problem = await response.json();
    console.error(`${response.status} ${problem.code}: ${problem.detail ?? problem.title}`);
    process.exit(1);
  }
  return response;
}

Authorizations

ApiKey

Request Body^required

application/json

object

url

required

null | string

description

required

null | string

Responses

201

Created

application/json

object

webhookId

required

string format: uuid

url

required

string

description

required

null | string

signingSecret

required

string

createdAt

required

string format: date-time

400

Bad Request: a problem with a stable code. See Errors for every code and what to do about it.

application/problem+json

Every error: a problem with a stable code. https://speccapture.com/docs/api/errors lists every code.

object

type

A link to the code’s entry in the docs.

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

code

What went wrong, as a stable code to branch on: a published code never changes meaning.

string

traceId

This request’s trace: quote it when asking for help.

string

403

Forbidden: a problem with a stable code. See Errors for every code and what to do about it.

application/problem+json

Every error: a problem with a stable code. https://speccapture.com/docs/api/errors lists every code.

object

type

A link to the code’s entry in the docs.

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

code

What went wrong, as a stable code to branch on: a published code never changes meaning.

string

traceId

This request’s trace: quote it when asking for help.

string

409

Conflict: a problem with a stable code. See Errors for every code and what to do about it.

application/problem+json

Every error: a problem with a stable code. https://speccapture.com/docs/api/errors lists every code.

object

type

A link to the code’s entry in the docs.

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

code

What went wrong, as a stable code to branch on: a published code never changes meaning.

string

traceId

This request’s trace: quote it when asking for help.

string

Add a webhook endpoint

Authorizations

Request Bodyrequired

Responses

201

400

403

409

Request Body^required