Knock Python library
Knock API access for applications written in Python.
Documentation
See the documentation for Python usage examples.
Installation
To install from PyPi, run the following:
pip install knockapiTo install from source, clone the repo and run the following:
python setup.py installConfiguration
To use the library you must provide a secret API key, provided in the Knock dashboard.
from knockapi import Knock
client = Knock(api_key="sk_12345")Usage
Identifying users
from knockapi import Knock
client = Knock(api_key="sk_12345")
client.users.identify(id="jhammond", data={"name": "John Hammond", "email": "jhammond@ingen.net"})Retrieving users
from knockapi import Knock
client = Knock(api_key="sk_12345")
client.users.get_user(id="jhammond")Sending notifies
from knockapi import Knock
client = Knock(api_key="sk_12345")
client.notify(
key="dinosaurs-loose",
actor="dnedry",
recipients=["jhammond", "agrant", "imalcolm", "esattler"],
cancellation_key=alert.id,
tenant="jurassic-park",
data={
"type": "trex",
"priority": 1
}
)Getting and setting channel data
from knockapi import Knock
client = Knock(api_key="sk_12345")
# Set channel data for an APNS
client.users.set_channel_data(
id="jhammond",
channel_id=KNOCK_APNS_CHANNEL_ID,
channel_data={
"tokens": [apns_token]
}
)
# Get channel data for the APNS channel
client.users.get_channel_data(id="jhammond", channel_id=KNOCK_APNS_CHANNEL_ID)Canceling notifies
from knockapi import Knock
client = Knock(api_key="sk_12345")
client.workflows.cancel(
key="dinosaurs-loose",
cancellation_key=alert.id,
recipients=["jhammond", "agrant", "imalcolm", "esattler"],
)User preferences
from knockapi import Knock
client = Knock(api_key="sk_12345")
# Replaces the preferences for the user
client.users.set_preferences(
user_id="jhammond",
channel_types={'email': True},
workflows={'dinosaurs-loose': False}
)
# Retrieve the current preferences
client.users.get_preferences(user_id="jhammond")Signing JWTs
You can use the pyjwt package to sign JWTs easily.
You will need to generate an environment specific signing key, which you can find in the Knock dashboard.
If you're using a signing token you will need to pass this to your client to perform authentication. You can read more about client-side authentication here.
import jwt
import os
private_key = os.getenv("KNOCK_SIGNING_KEY")
encoded = jwt.encode({"sub": "jhammond"}, private_key, algorithm="RS256")
