Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

The Things Network / The Things Stack ApplicationWebhookRegistry API

The ApplicationWebhookRegistry API from The Things Network / The Things Stack — 8 operation(s) for applicationwebhookregistry.

The Things Network / The Things Stack ApplicationWebhookRegistry API is one of 58 APIs that The Things Network / The Things Stack publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 9 JSON Schema definitions.

Tagged areas include ApplicationWebhookRegistry. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 9 JSON Schemas.

This API exposes 8 operations across 8 paths, and defines 18 schemas. It is described by OpenAPI 2.0, at version v3.36.

8 operations 8 paths 18 schemas 1 DELETE5 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v3.36
Authentication
API Key
License
Resource Areas
1

Authentication & Security 1

The Things Network / The Things Stack ApplicationWebhookRegistry API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — Bearer API key. Set Authorization: Bearer NNSXS.xxxxxxxxxx.

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 1 DELETE, 5 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

ApplicationWebhookRegistry 8
GET
/as/webhook-formats
ApplicationWebhookRegistry_GetFormats → 200default
GET
/as/webhook-templates
ApplicationWebhookRegistry_ListTemplates 1 param → 200default
GET
/as/webhook-templates/{ids.template_id}
ApplicationWebhookRegistry_GetTemplate 2 params → 200default
GET
/as/webhooks/{application_ids.application_id}
ApplicationWebhookRegistry_List 4 params → 200default
DELETE
/as/webhooks/{application_ids.application_id}/{webhook_id}
ApplicationWebhookRegistry_Delete 2 params → 200default
GET
/as/webhooks/{ids.application_ids.application_id}/{ids.webhook_id}
ApplicationWebhookRegistry_Get 3 params → 200default
POST
/as/webhooks/{webhook.ids.application_ids.application_id}
ApplicationWebhookRegistry_Set2 2 params → 200default
PUT
/as/webhooks/{webhook.ids.application_ids.application_id}/{webhook.ids.webhook_id}
ApplicationWebhookRegistry_Set 3 params → 200default

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are v3ApplicationWebhook (23 properties), v3ApplicationWebhookTemplate (23 properties), v3ErrorDetails (8 properties), v3ApplicationWebhookTemplateField (6 properties). Each schema is shown below with its type and property counts.

v3ApplicationWebhookMessage
object
1 property
v3ApplicationWebhookIdentifiers
object
2 properties
v3ApplicationWebhookTemplate
object
23 properties
ApplicationWebhookHealthWebhookHealthStatusHealthy
object
v3ApplicationWebhookTemplateField
object
ApplicationWebhookTemplateField represents a custom field that needs to be filled by the user in order to use the template. A field can be an API key, an usern…
6 properties
v3ApplicationWebhookHealth
object
2 properties
googlerpcStatus
object
3 properties
v3ApplicationWebhookFormats
object
1 property
v3ApplicationWebhook
object
23 properties
v3ApplicationIdentifiers
object
1 property
v3ApplicationWebhookTemplateMessage
object
1 property
v3ApplicationWebhookTemplates
object
1 property
v3ApplicationWebhooks
object
1 property
v3ApplicationWebhookRegistrySetBody
object
2 properties
ApplicationWebhookHealthWebhookHealthStatusUnhealthy
object
3 properties
protobufAny
object
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides supp…
1 property
v3ApplicationWebhookTemplateIdentifiers
object
1 property
v3ErrorDetails
object
Error details that are communicated over gRPC (and HTTP) APIs. The messages (for translation) are stored as "error: : ".
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

the-things-network-applicationwebhookregistry-api-openapi.yml Raw ↑

Other APIs The Things Network / The Things Stack publishes across the network.

The Things Network / The Things Stack AppAs API
The Things Network / The Things Stack ApplicationAccess API
The Things Network / The Things Stack ApplicationActivationSettingRegistry API
The Things Network / The Things Stack ApplicationPackageRegistry API
The Things Network / The Things Stack ApplicationPubSubRegistry API
The Things Network / The Things Stack ApplicationRegistry API
The Things Network / The Things Stack ApplicationUpStorage API
The Things Network / The Things Stack As API
The Things Network / The Things Stack AsEndDeviceBatchRegistry API
The Things Network / The Things Stack AsEndDeviceRegistry API
The Things Network / The Things Stack ClientAccess API
The Things Network / The Things Stack ClientRegistry API