wazo-platform / wazo-webhookd-client

wazo-webhookd-client

A python client library to access wazo-webhookd

Usage

Creating a client

from wazo_webhookd_client import Client
client = Client('localhost', verify_certificate=False, token=<auth-token>)

Subscriptions

Listing hook subscriptions

client.subscriptions.list()
client.subscriptions.list_as_user()  # same thing, but only the subscriptions regarding the user making the request are considered

Add a new hook subscription

subscription = {
    'name': 'test',
    'service': 'http',
    'config': {
        'url': 'http://test.example.com',
        'method': 'get'
    },
    'events': ['confd.users.create']
}
client.subscriptions.create(subscription)
client.subscriptions.create_as_user(subscription)  # same thing, but only the events regarding the user making the request are considered

Get hook subscription

subscription = client.subscriptions.get(subscription_uuid)
subscription = client.subscriptions.get_as_user(subscription_uuid)  # same thing, but only the subscriptions regarding the user making the request are considered

Get hook subscription logs

client.subscriptions.get_logs(subscription_uuid)

Update hook subscription

subscription = client.subscriptions.update(subscription_uuid, new_subscription)
subscription = client.subscriptions.update_as_user(subscription_uuid, new_subscription)  # same thing, but only the subscriptions regarding the user making the request are considered

Delete hook subscription

client.subscriptions.delete(subscription_uuid)
client.subscriptions.delete_as_user(subscription_uuid)  # same thing, but only the subscriptions regarding the user making the request are considered

Config

Getting the service configuration

client.config.get()

Updating the service configuration

config_patch = {
    'op': 'replace',
    'path': '/debug',
    'value': True,
}
client.config.patch(config_patch)

Push notifications

Sending a push notification

push_notification = {
    'notification_type': 'example_notification',
    'user_uuid': '06306028-d9eb-4556-97d4-5e9f820309d0',
    'title': 'Notification title',
    'body': 'Notification body',
    'extra': {'key': 'value'},
}
client.mobile_notifications.send(push_notification)

Debian package

Follow the following steps to build a debian package for wazo-webhookd-client manually.

1. Copy the source directory to a machine with all dependencies installed

rsync -av . <builder-host>:~/wazo-webhookd-client

2. On the host, increment the changelog

dch -i

3. Build the package

dpkg-buildpackage -us -uc