Subscribe Webhook

Resource

POST api/v1/webhook/subscribe

Authorization

OAuth 2.0 bearer token with Business scope.

Request

curl -X POST \
  https://api.gett.com/v1/webhook/subscribe \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer [TOKEN]' \
  -H 'Cache-Control: no-cache' \
  -H 'Content-Type: application/json' \
  -d '{
        "hook_address":"http://host/endpoint",
        "retries": 52,
        "env": "prod"
      }'

Note:
Our webhook service has the ability to resend webhook events in case the webhook address is not reachable.
In order to activate it, "retries":N" must be added right after the "hook_address".
'N' is the retry interval.
The retry intervals will grow exponentially from 1 minute to 30 minutes and will be made up to N times.
Our webhook service has the ability to send webhook events to two separate environments, "prod" and "sandbox".

Response

{
  "created_at": "2018-03-18T12:00:25.543804071+02:00",
  "updated_at": "2018-03-18T12:00:25.543804071+02:00",
  "hook_address": "http://example.com/webhook",
  "secret_id": "8750d38f-62f0-418b-9322-106fa4a3fe28",
  "id": "2e2ad86e-13d8-4348-b4ef-9b67051802fe"
}

Name

Type

Description

created_at

date

RFC 3339 date. states when subscription has been created.

updated_at

date

RFC 3339 date. states when subscription has been updated.

hook_address

string

valid url of endpoint to receive updates.

secret_id

string

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

id

string

uuid subscription id.


Did this page help you?