Send a test delivery
Delivers a webhook.test event to one of your endpoints right now and reports what actually happened, so you can confirm the URL is reachable and your signature check works without waiting for a real search.
The request is byte-for-byte the same shape as a real delivery: same X-Mapleads-Signature (HMAC-SHA256 of the body with your endpoint secret), same headers, same timeout, same outbound IP pinning.
The event type is webhook.test, never a fake search.completed — so your receiver can ignore it instead of running real business logic.
⚠️ A failed delivery still returns 200: you asked us to test, and we are reporting the result. Check ok in the body, not the HTTP status. 400 means we could not send at all (for example the URL no longer resolves to a public address).
Requires the webhooks:write scope — it changes nothing here, but it makes our servers call the URL you configured.
/v1/webhooks/testDelivers a webhook.test event to one of your endpoints right now and reports what actually happened, so you can confirm the URL is reachable and your signature check works without waiting for a real search.
The request is byte-for-byte the same shape as a real delivery: same X-Mapleads-Signature (HMAC-SHA256 of the body with your endpoint secret), same headers, same timeout, same outbound IP pinning.
The event type is webhook.test, never a fake search.completed — so your receiver can ignore it instead of running real business logic.
⚠️ A failed delivery still returns 200: you asked us to test, and we are reporting the result. Check ok in the body, not the HTTP status. 400 means we could not send at all (for example the URL no longer resolves to a public address).
Requires the webhooks:write scope — it changes nothing here, but it makes our servers call the URL you configured.
Pass Authorization: Bearer mapleads_xxx.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Id of the endpoint to test.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/webhooks/test" \ -H "Content-Type: application/json" \ -d '{ "endpointId": "string" }'{ "ok": true, "deliveryId": "string", "status": 0, "error": "string"}Delete a webhook endpoint DELETE
Deletes a webhook endpoint. Requires the `webhooks:write` scope when called with a scoped key.
Get usage and credits GET
Returns the authenticated account's access state, remaining credits, allowance, reset date, and effective API-key rate limit. Requires the `usage:read` scope when called with a scoped key.