Top - Pixela Help Center/🇺🇸Pixela Help center/Webhook
page icon

Webhook

These are APIs for support doing 🪄Instant recording without setting a credential to HTTP header.

Releated API

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
 
Therefore, for more detail about each operation, please see 🪄Instant recording .

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 for add and subtract type webhooks.
    • If an add or subtract webhook is invoked with no quantity property set, a default value of 1 or 0.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.

Related links