Test webhook subscription

Resource

POST api/v1/webhook/subscribe/test

Authorization

OAuth 2.0 bearer token with Business scope.

Request

curl -X POST \
  https://api.gett.com/v1/webhook/subscribe/test \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer [TOKEN]' \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json' \

Responce

{
    "message": "ok",
 }

On top of the response each subscribed endpoint will get the following message

{
   "id": "a9329a64-8a59-428a-9254-2313edc7417c",
   "event_type": "test.event.updated",
   "hook_address": "example.com/webhook",
   "message": "Test me",
   "timestamp": "2018-03-18T12:00:25.543804071+02:00",
 }

Name

Type

Description

created_at

date

RFC 3339 date. states when subscription has been created.

updates_at

date

RFC 3339 date. states when subscription has been updated.

hook_address

string

valid url of endpoint to receive updates.

id

string

uuid subscription id.

secret_id

string

uuid verification token used to validate that request was sent from Gett.


Did this page help you?