Webhooks

Add a webhook endpoint

Tell us where to POST when a collection ends, instead of asking us every few seconds whether it is done. The answer shows the signing secret once and never again. Store it, then check every request against it. The body carries counts and a link to the places, never the places themselves. Needs an API key and a paid plan. Costs no credits.

post/webhooks

Request

  • Base URL: https://api.gmaps.dev/v1
  • URL: https://api.gmaps.dev/v1/webhooks
  • Auth: HTTP bearer

Request body

urlstring uri required

Where to POST the event. Must start with https:// and resolve to a public address. We will not send your results unencrypted or into a private network.

eventsstring[]

Which events to send here. "collection.completed" fires when a collection ends, even one that found no places; "collection.failed" fires when an error stops it. A collection you cancel sends neither.

descriptionstring

Your own note about this endpoint, such as which of your services it is.

Response

Add a webhook endpoint

Changes

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