API reference

Manage signed inbound connections

Create and inspect workspace connections used to verify inbound events from external systems.

API reference

Connection lifecycle

Any workspace member can list inbound connections. Administrators can create and delete them. Creation returns the plaintext signing secret once, so store it with the sending system before leaving the response.

Provider callbacks such as Nango and Slack use their own verified routes. Do not send those events to a generic workspace connection unless the provider setup specifically instructs you to do so.

GET: List the signed inbound connections in a workspace
POST: Create a connection as a workspace administrator
DELETE: Remove a connection as a workspace administrator

import json
import os
import urllib.request

url = "https://api.trysupervisor.com/workspaces/{workspaceId}/connections"
request = urllib.request.Request(url, method="GET")
request.add_header("Authorization", f"Bearer {os.environ['SUPERVISOR_API_KEY']}")
request.add_header("Content-Type", "application/json")

with urllib.request.urlopen(request) as response:
    result = json.load(response)
    print(json.dumps(result, indent=2))

Delivery safety

Verify signatures before processing a payload. Store a delivery identifier and make handlers idempotent so a retried event cannot repeat a completed side effect.

Keep signing secrets out of client applications. Rotate a connection if its secret may have been exposed.