Turn a stopped webhook endpoint back on

POST

/v1/webhooks/{webhookId}/resume

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

WEBHOOK_ID=0f8fad5b-d9cb-469f-a165-70867728950e  # the webhookId from adding the endpoint

curl -sS --fail-with-body -X POST "$API/v1/webhooks/$WEBHOOK_ID/resume" \
  -H "$AUTH"
echo "Endpoint $WEBHOOK_ID receives events again"

using System.Text.Json;

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

string webhookId = args[0]; // the webhookId from adding the endpoint

await Call(HttpMethod.Post, $"/v1/webhooks/{webhookId}/resume");
Console.WriteLine($"Endpoint {webhookId} receives events again");

// 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_id = sys.argv[1]  # the webhookId from adding the endpoint

call("POST", f"/v1/webhooks/{webhook_id}/resume")
print(f"Endpoint {webhook_id} receives events again")

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

const [webhookId] = process.argv.slice(2); // the webhookId from adding the endpoint

await call("POST", `/v1/webhooks/${webhookId}/resume`);
console.log(`Endpoint ${webhookId} receives events again`);

// 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;
}

An endpoint that answers a delivery with 410 Gone is stopped: nothing more is queued for it or sent to it, and GET /v1/webhooks shows when it was stopped (stoppedAt). This turns it back on, with the signing secret it always had. Events that finished while it was stopped are not sent; fetch those jobs with GET /v1/extractions/{jobId}. An endpoint that is on is left as it is. A live key acting as the workspace’s owner or an admin.

Authorizations

ApiKey

Parameters

Path Parameters

webhookId

required

string format: uuid

Responses

204

No Content

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

404

Not Found: 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