Application Webhook APIs

The ApplicationWebhookRegistry service

Method ApplicationWebhookRegistry.GetFormats
Request type google.protobuf.Empty
Response type ApplicationWebhookFormats
HTTP bindings

GET /api/v3/as/webhook-formats

Method ApplicationWebhookRegistry.Set
Request type SetApplicationWebhookRequest
Response type ApplicationWebhook
HTTP bindings

PUT /api/v3/as/webhooks/{webhook.ids.application_ids.application_id}/{webhook.ids.webhook_id}

POST /api/v3/as/webhooks/{webhook.ids.application_ids.application_id}

Method ApplicationWebhookRegistry.Get
Request type GetApplicationWebhookRequest
Response type ApplicationWebhook
HTTP bindings

GET /api/v3/as/webhooks/{ids.application_ids.application_id}/{ids.webhook_id}

Method ApplicationWebhookRegistry.List
Request type ListApplicationWebhooksRequest
Response type ApplicationWebhooks
HTTP bindings

GET /api/v3/as/webhooks/{application_ids.application_id}

Method ApplicationWebhookRegistry.Delete
Request type ApplicationWebhookIdentifiers
Response type google.protobuf.Empty
HTTP bindings

DELETE /api/v3/as/webhooks/{application_ids.application_id}/{webhook_id}

Messages

Message ApplicationWebhook

Field ids
Type ApplicationWebhookIdentifiers
Description

required

Field created_at
Type google.protobuf.Timestamp
Field updated_at
Type google.protobuf.Timestamp
Field base_url
Type string
Description

Base URL to which the message’s path is appended.

uri

Field headers
Type map of string to string
Description

HTTP headers to use.

Field format
Type string
Description

The format to use for the body. Supported values depend on the Application Server configuration.

max_len: 20

pattern: ^[a-z0-9](?:[-]?[a-z0-9]){2,}$

Field template_ids
Type ApplicationWebhookTemplateIdentifiers
Description

The ID of the template that was used to create the Webhook.

Field template_fields
Type map of string to string
Description

The value of the fields used by the template. Maps field.id to the value.

Field downlink_api_key
Type string
Description

The API key to be used for downlink queue operations. The field is provided for convenience reasons, and can contain API keys with additional rights (albeit this is discouraged).

Field uplink_message
Type ApplicationWebhook.Message
Field join_accept
Type ApplicationWebhook.Message
Field downlink_ack
Type ApplicationWebhook.Message
Field downlink_nack
Type ApplicationWebhook.Message
Field downlink_sent
Type ApplicationWebhook.Message
Field downlink_failed
Type ApplicationWebhook.Message
Field downlink_queued
Type ApplicationWebhook.Message
Field downlink_queue_invalidated
Type ApplicationWebhook.Message
Field location_solved
Type ApplicationWebhook.Message
Field service_data
Type ApplicationWebhook.Message
Show object example
{
  "ids": {},
  "created_at": "0001-01-01T00:00:00Z",
  "updated_at": "0001-01-01T00:00:00Z",
  "base_url": "",
  "headers": {},
  "format": "",
  "template_ids": {},
  "template_fields": {},
  "downlink_api_key": "",
  "uplink_message": {},
  "join_accept": {},
  "downlink_ack": {},
  "downlink_nack": {},
  "downlink_sent": {},
  "downlink_failed": {},
  "downlink_queued": {},
  "downlink_queue_invalidated": {},
  "location_solved": {},
  "service_data": {},
}

Message ApplicationWebhook.Message

Field path
Type string
Description

Path to append to the base URL.

Show object example
{
  "path": "",
}

Message ApplicationWebhookFormats

Field formats
Type map of string to string
Description

Format and description.

Show object example
{
  "formats": {},
}

Message ApplicationWebhookIdentifiers

Field application_ids
Type ApplicationIdentifiers
Description

required

Field webhook_id
Type string
Description

max_len: 36

pattern: ^[a-z0-9](?:[-]?[a-z0-9]){2,}$

Show object example
{
  "application_ids": {},
  "webhook_id": "",
}

Message ApplicationWebhooks

Field webhooks
Type repeated ApplicationWebhook
Description
Show object example
{
  "webhooks": [],
}

Message ApplicationWebhookTemplateIdentifiers

Field template_id
Type string
Description

max_len: 36

pattern: ^[a-z0-9](?:[-]?[a-z0-9]){2,}$

Show object example
{
  "template_id": "",
}

Message GetApplicationWebhookRequest

Field ids
Type ApplicationWebhookIdentifiers
Description

required

Field field_mask
Type google.protobuf.FieldMask
Show object example
{
  "ids": {},
  "field_mask": {},
}

Message ListApplicationWebhooksRequest

Field application_ids
Type ApplicationIdentifiers
Description

required

Field field_mask
Type google.protobuf.FieldMask
Show object example
{
  "application_ids": {},
  "field_mask": {},
}

Message SetApplicationWebhookRequest

Field webhook
Type ApplicationWebhook
Description

required

Field field_mask
Type google.protobuf.FieldMask
Show object example
{
  "webhook": {},
  "field_mask": {},
}