Sign In
Sign Out

Steps of Registering a Hook

Before registering your first Hook, it is useful to have a high-level overview of the steps it involves.

Hook registration sequence diagram

Hooks are implemented in AR Cloud as SNS topic subscriptions. SNS is a service provided by Amazon Web Services (AWS). Before starting to process forwarded events, you (or your system) must confirm the subscription. After successful confirmation, all future recognition events will be sent to the webhook endpoint.

  1. You set up a web server that listens at the URI you wish to register as a Hook.
  2. You register a webhook via the Cloud Dashboard.
  3. AR Cloud initiates the subscription process.
  4. Your web server receives an SNS subscription request from AWS.
  5. You send an HTTP GET request to the unique confirmation URI included in the subscription request. This can be done either automatically by the server or manually by entering the URI in a browser's address bar.
  6. All recognition events after successful confirmation are forwarded to the Hook in HTTP POST requests.