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 Type Description
ids ApplicationWebhookIdentifiers

required

created_at google.protobuf.Timestamp
updated_at google.protobuf.Timestamp
base_url string

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

uri

headers map of string to string

HTTP headers to use.

format string

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,}$

template_ids ApplicationWebhookTemplateIdentifiers

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

template_fields map of string to string

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

downlink_api_key string

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).

uplink_message ApplicationWebhook.Message
join_accept ApplicationWebhook.Message
downlink_ack ApplicationWebhook.Message
downlink_nack ApplicationWebhook.Message
downlink_sent ApplicationWebhook.Message
downlink_failed ApplicationWebhook.Message
downlink_queued ApplicationWebhook.Message
location_solved ApplicationWebhook.Message
service_data 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": {},
  "location_solved": {},
  "service_data": {},
}

Message ApplicationWebhook.Message

Field Type Description
path string

Path to append to the base URL.

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

Message ApplicationWebhookFormats

Field Type Description
formats map of string to string

Format and description.

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

Message ApplicationWebhookIdentifiers

Field Type Description
application_ids ApplicationIdentifiers

required

webhook_id string

max_len: 36

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

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

Message ApplicationWebhooks

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

Message ApplicationWebhookTemplateIdentifiers

Field Type Description
template_id string

max_len: 36

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

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

Message GetApplicationWebhookRequest

Field Type Description
ids ApplicationWebhookIdentifiers

required

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

Message ListApplicationWebhooksRequest

Field Type Description
application_ids ApplicationIdentifiers

required

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

Message SetApplicationWebhookRequest

Field Type Description
webhook ApplicationWebhook

required

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