Skip to content

Instantly share code, notes, and snippets.

View thomas-layer's full-sized avatar

Thomas A. Joseph thomas-layer

  • Layer
View GitHub Profile
@thomas-layer
thomas-layer / layer-data-services-overview.md
Last active August 29, 2015 14:27
Overview of Layer Data Services

Layer Data Services

Disclaimer: This document includes Layer features that are in progress or are planned in the future. This should be not interpreted as a commitment that these features will be built, or will be built as described. The purpose of this document is to share our plans with select customers to aid them in planning, and for us to receive their feedback.

Context

Layer takes the position that our customers' data belongs to them, and that they have full access to it.

@thomas-layer
thomas-layer / layer-webhooks-api.md
Created August 11, 2015 22:27
Layer Webhooks API

Layer Webhooks

Webhooks allow you to develop integrations which subscribe to events within your Layer application. When a subscribed event is triggered, Layer will send an HTTP POST payload to the endpoint designated in the webhook configuration. Webhooks provide a simple, flexible mechanism that you can use to signal an external system to take action in response to messaging activity within your app. You can use Webhooks to implement things like:

  • Add context to conversations: respond to messages mentioning keywords.
  • Notify another user when they are @mentioned
  • Send a welcome message when a user registers (build a great onboarding experience)
  • Integrate a third-party service (Uber API, Weather Underground, etc) into conversations based on context

Event Types

Insights API

The Insights API is the interactive interface for time based metrics as part of the Layer Data Services. It is intended to allow users to query metrics that have been pre-aggregated by us, with or without a limited amount of post-aggregation. Although the Insights API is modelled on common analytics APIs, this API is not intended for the Layer Data Services to be used as a replacement for an analytical database. Rather, as the name implies, it is intended to give our users insights into how they and their users are using Layer. Separately, the Layer Data Services will provide the ability to download relevant data into common analytical databases like Amazon Redshift and Google BigQuery, where it can be combined with other data and used for data analysis.

Concepts