Get a webhook

GET/webhooks/{id}

Authorization

AuthorizationBearer token (JWT) · headerrequired

Path parameters

idintegerrequired

Responses

200

Webhook details

_linksHalLinks

idinteger

channel_idinteger

topicstring

The topic, spelled the way this subscription receives it (see topic_style).

topic_stylestring

How the topic is spelled in the notifications this subscription receives. Subscriptions created through v2 are singular; those created before the singular spelling existed, or through v1, stay plural so their consumers are not affected.

Allowed:singularplural

urlstring

statusstring

active — receiving deliveries normally. failed_activation — the initial activation handshake failed. failed — disabled automatically after 100 consecutive non-2xx delivery responses (see error_count); can be re-enabled via PUT /webhooks/{id}/reactivate. disabled — the target URL returned 410 Gone; disabled immediately, with no retry threshold. Also reactivatable via the same endpoint.

Allowed:activefailed_activationfaileddisabled

authobject

notify_originboolean

app_idinteger

error_countinteger

last_errorstring

last_error_onstring<date-time>

created_onstring<date-time>

updated_onstring<date-time>

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

idpath*

Request

curl -X GET 'https://api.onbolder.com/v2/webhooks/0' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'

const response = await fetch("https://api.onbolder.com/v2/webhooks/0", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://api.onbolder.com/v2/webhooks/0",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
)

Response

{
  "_links": {
    "property1": {
      "href": "string",
      "templated": true,
      "method": "get",
      "title": "string",
      "type": "string"
    },
    "property2": {
      "href": "string",
      "templated": true,
      "method": "get",
      "title": "string",
      "type": "string"
    }
  },
  "id": 0,
  "channel_id": 0,
  "topic": "order.created",
  "topic_style": "singular",
  "url": "https://myapp.com/events",
  "status": "active",
  "auth": {},
  "notify_origin": true,
  "app_id": 0,
  "error_count": 0,
  "last_error": "string",
  "last_error_on": "2019-08-24T14:15:22Z",
  "created_on": "2019-08-24T14:15:22Z",
  "updated_on": "2019-08-24T14:15:22Z"
}