
Webhook
Releated API
- POST - /v1/users/<username>/webhooks
- This is an API for creating a new Webhook.
- GET - /v1/users/<username>/webhooks
- This is an API for getting a list of existing Webhooks whose user specified with
<username>
.
- POST - /v1/users/<username>/webhooks/<webhookHash>
- This is an API for invoking a process by Webhook already created.
- DELETE - /v1/users/<username>/webhooks/<webhookHash>
- This is an API for deleting an existing Webhook.
Features
When you request an existing Webhook for invoking, you need not set a credential to HTTP header.
By creating a Webhook in advance, you can record quantity in real-time from clients that are not allowed to set any HTTP headers, such as some smart speakers.
Specifications
The operations that you can invoke by using webhook are the following three types, which are equivalent to the types of operations by using Instant recording.
increment
decrement
add
subtract
stopwatch
Notes
- It is not required a credential when invoking webhook, so please take care about anyone can invoke operations by invoking Webhook if
<webhookHash>
is leaked.
- When creating a webhook, you can specify the
quantity
property (POST - /v1/users/<username>/webhooks - Pixela API Document). This property is foradd
andsubtract
type webhooks. - If an
add
orsubtract
webhook is invoked with noquantity
property set, a default value of1
or0.01
is used. - It is possible to set the quantity property on the
incremenet
decrement
stopwatch
type webhook, but that setting is not used for anything.