Update Webhook
Update a webhook endpoint, move it to another sender profile, or rotate its secret.
Update a webhook. Fields omitted from the request are unchanged. The response includes the current signing secret.
Scope: verify.webhooks.write
Path Parameters
idstringrequiredWebhook ID with the whk_ prefix.
Request Body
sender_profile_idstringoptionalMove the webhook to another sender profile owned by the account.
urlstringoptionalNew HTTP or HTTPS endpoint URL.
enabledbooleanoptionalWhether the webhook receives events.
rotate_secretbooleanoptionalSet to true to generate a new signing secret.
Sample Request
Request
curl -X PATCH "https://api.maileroo.com/v1/verify/webhooks/whk_0123456789abcdef01234567" \
-H "Authorization: Bearer roo_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{"url":"https://example.com/hooks/otp","rotate_secret":true}'Sample Response
Returns 200 OK. The response includes the new secret when rotate_secret is true.
Response
{
"data": {
"id": "whk_0123456789abcdef01234567",
"account_id": "12345",
"sender_profile_id": "prf_0123456789abcdef01234567",
"url": "https://example.com/hooks/otp",
"secret": "abcdef0123456789abcdef0123456789abcdef0123456789abcdef0123456789",
"enabled": true,
"created_at": "2025-01-01T12:00:00Z",
"updated_at": "2025-01-02T09:00:00Z"
}
}Errors
Common authentication, rate-limit, and service-availability errors are described in the Introduction. This endpoint can also return:
400 Bad Request— invalid JSON, URL, or sender profile ID.404 Not Found— the webhook or replacement sender profile does not exist for this account.