webhooks

Update subscription

Update subscription properties, such as callback_uri and status.

post/subscriptions/{id}

Request

Base URL
https://api.skywatch.co/earthcache
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/skywatch/apis/api-specification/docs/subscriptions/:id/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Request body

eventsstring[]

secretstring

When your secret token is set, a hash signature is created with each payload. This hash signature is included with the headers of each request as x-ec-signature-256.

The intention is to calculate a hash of the payload received using your secret token, and check that the hash matches the one from EarthCache.

callback_uristring uri

status'active' | 'inactive'

callback_headersobject

Response

Success - subscription updated; no content returned

Changes

No recorded changes to this operation across all 1 revision of this API.