Webhooks
Send a ping event
Queues a signed test.ping event to your business's webhook URL, saved in the dashboard. Its data.message is "This is a ping event from Solverr." Returns 409 with the message "Set a webhook URL in the dashboard first." when no webhook URL is set, and 409 with a message saying webhooks are off when the endpoint answered 410 Gone and its URL was not saved again. The worker looks for due events every 5 seconds. With an Idempotency-Key, a retry returns the first result instead of queuing a second ping.
Rate limit: 10 per minute per business.
bearerAuthAuthorizationBearer <token>A live API key, sk_live_ followed by 32 base58 characters.
Idempotency-Key?stringA unique string of 1 to 255 characters for this operation. A key belongs to the business across every endpoint for 24 hours, so give each operation its own key, for example invoice-order-1042 and refund-order-1042, not the order id alone. A retry with the same key on the same endpoint and with the same body returns the stored response with the header Idempotent-Replayed: true. The same key with a different body or on another endpoint returns 409 idempotency_conflict. Errors are not stored, so a request that failed can be retried with the same key, even with a corrected body. While the first request with a key is still running, a retry gets 409 idempotency_conflict with Retry-After: 1.
1 <= length <= 255The ping event was queued.
application/json- response
queued*booleancurl -X POST 'https://example.com/api/v1/webhooks/test'{ "queued": true}