Webhooks

Change a webhook endpoint

Change which events an endpoint receives, rename it, or switch it off and on. This is how an endpoint comes back after we stopped sending to it: fix your server, then set enabled to true. The failure count starts again from zero. Whatever you leave out stays as it was. Needs an API key and a paid plan. Costs no credits.

post/webhooks/{id}

Request

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

Path parameters

idstring uuid required

The endpoint's id, as create_webhook returned it.

Request body

enabledboolean

False to stop sending here without deleting it. True to start again after we switched it off.

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 nullable

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

Response

Change a webhook endpoint

Changes

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