Webhooks allow you to receive real-time updates about changes in Rye’s data.
Navigate to Account Settings
Set Up an Endpoint
URL Verification Handshake
challenge
parameter. Your endpoint must respond with the exact challenge
value to confirm it can receive webhooks. Rye will only save the URL if the challenge is successfully verified.Verification Request Example:Verify Functionality
Implement Signature Verification
Rye-Hmac-Signature-V1
header to verify authenticity.challenge
during setup.Header | Description |
---|---|
Rye-Hmac-Signature-V1 | Cryptographic signature to verify the webhook’s authenticity. Refer to the verification section for details. |
Rye-Verification | Your developer account ID, useful for endpoints handling multiple Rye accounts. |
Rye-Hmac-Signature-V1
header.challenge
, respond with its value to complete verification.RYE_HMAC_SECRET_KEY
environment variable is set in your application.
createdAt
timestamp to sequence events appropriately in your system.