Webhook

REQUIREMENT
The base URL for all API requests is https://api.otterwaiver.com
NOTE
The authentication token is required to authorize requests. It MUST be specified in the header parameter for these requests

You can configure webhook endpoints via the API to be notified about events that happen after connecting to zapier. Setting up zapier with otter waiver allows you to send realtime notifications to any application (slack, email, discord etc.) or webhook endpoint.

Subscribe to events

This operation subscribe an endpoint to receive events.

POST /webhook/subscribe

{
 "trigger": "CheckIn",
 "webhook": "https://webhook.site/835020cd-54b0-44ac-8d92-cb74615354bd"
}

curl --location --request POST 'https://api.otterwaiver.com/webhook/subscribe' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InF1YW1lbGV4aXpAZ21haWwuY29tIiwiaWQiOiIxYmFmOGVjZi03OGE4LTQ0ZDItOTI3Mi0zNjkzYjk2OGY4ZTEiLCJwcm92aWRlciI6ImxvY2FsIiwicm9sZSI6eyJsYWJlbCI6Ik9yZ2FuaXphdGlvbiBBZG1pbiIsInZhbHVlIjoiT1JHQU5JWkFUSU9OX0FETUlOIn0sIm9yZ2FuaXphdGlvbklkIjoiZDhlYjRmN2UtZTJlZC00YjhiLTg5ZDUtZGIwMGUzNzI3NjRjIiwiaWF0IjoxNjQyMDc0MzM2LCJleHAiOjE2NzM2MzE5MzZ9.B6kv3lZbateWogmyNVvyfD_-Wr9Wf7kMe2NO-IB2g0c' \
--header 'Content-Type: application/json' \
--data-raw '{
"trigger": "CheckIn",
"webhook": "https://webhook.site/835020cd-54b0-44ac-8d92-cb74615354bd"
}'


{
    "id":"21be8b0c-5097-4331-93a2-61e77060bca6",
    "createdAt":"2021-11-30T16:13:41.027Z",
    "trigger":"CheckIn",
    "webhook":"https://webhook.site/835020cd-54b0-44ac-8d92-cb74615354bd"
}

REQUEST PARAMETERS

trigger

This refers to the event for which you want to listen receive notifications. Allowed Triggers: CheckIn, New Signee

webhook

This refers to the URL that listens to the event type in the trigger.

RESPONSE PARAMETERS

id

This is the unique identifier for the created resource

createdAt

This is the creation timestamp for this resource

trigger

This refers to the event for which you want to listen receive notifications.

webhook

This refers to the URL that listens to the event type in the trigger.

Unsubscribe to events

This operation removes/deletes webhook endpoints. You can use this whenever you want to unsubscribe to events.

POST /webhook/unsubscribe

{
 "trigger": "CheckIn",
 "webhook": "https://webhook.site/835020cd-54b0-44ac-8d92-cb74615354bd"
}

curl --location --request POST 'https://api.otterwaiver.com/webhook/subscribe' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InF1YW1lbGV4aXpAZ21haWwuY29tIiwiaWQiOiIxYmFmOGVjZi03OGE4LTQ0ZDItOTI3Mi0zNjkzYjk2OGY4ZTEiLCJwcm92aWRlciI6ImxvY2FsIiwicm9sZSI6eyJsYWJlbCI6Ik9yZ2FuaXphdGlvbiBBZG1pbiIsInZhbHVlIjoiT1JHQU5JWkFUSU9OX0FETUlOIn0sIm9yZ2FuaXphdGlvbklkIjoiZDhlYjRmN2UtZTJlZC00YjhiLTg5ZDUtZGIwMGUzNzI3NjRjIiwiaWF0IjoxNjQyMDc0MzM2LCJleHAiOjE2NzM2MzE5MzZ9.B6kv3lZbateWogmyNVvyfD_-Wr9Wf7kMe2NO-IB2g0c' \
--header 'Content-Type: application/json' \
--data-raw '{
"trigger": "CheckIn",
"webhook": "https://webhook.site/835020cd-54b0-44ac-8d92-cb74615354bd"
}'


{
    "sent":true,
    "message":"Unsubscription Successful"
}

REQUEST PARAMETERS

trigger

This refers to the event for which you want to listen receive notifications. Allowed Triggers: CheckIn, New Signee

webhook

This refers to the URL that listens to the event type in the trigger.

RESPONSE PARAMETERS

sent

A boolean that shows the status of the request to unsubscribe.

message

A human readable response returned after unsubscription.

Folders Waiver