Skip to main content

HTTP Tunneling

Motivation​

AutoKitteh integrations hide away the complexities of using third-party services and APIs:

  • Support for the OAuth 2.0 protocol
  • Handling external asynchronous events
    • Receiving them without over/under-capacity concerns
    • Relaying them reliably and securely to all interested workflows
    • Acknowledging them in a timely manner

This depends on exposing AutoKitteh's webhooks as publicly-accessible HTTPS endpoints. There are many options to do this; a popular "freemium" solution is ngrok.

Set-Up ngrok​

  1. Install ngrok, according to step 1 here: https://ngrok.com/docs/getting-started/

  2. Connect your ngrok agent to your ngrok account, according to step 2 in the same quickstart guide

  3. Create a static domain on your ngrok dashboard: https://dashboard.ngrok.com/cloud-edge/domains

  4. Run this command to start ngrok:

    ngrok http 9980 --domain example.ngrok.dev
    note
    • 9980 is AutoKitteh's local HTTP port
    • example.ngrok.dev is the domain you've registered in step 3

Configure AutoKitteh​

Set this environment variable, based on the step 3 above:

  • WEBHOOK_ADDRESS
tip

Specify just the address, without the https:// prefix, and without a path suffix, e.g. example.ngrok.dev.