Webhooks
Webhooks allow you to receive real-time notifications about events that occur in your Skippy account, enabling you to automate workflows and keep your systems synchronized.
Setting up Webhooks
- Navigate to your project settings and go to "Webhooks"
- Click "Create Webhook" and provide a URL endpoint
- Select the events you want to receive notifications for
- Save your webhook configuration
Receiving Webhooks
Your endpoint will receive POST requests with event data in JSON format. Ensure your endpoint:
- Accepts POST requests
- Returns a 200 status code to acknowledge receipt
- Uses HTTPS for secure communication
Supported Events
Credential Issuance Events
| Event | Display State | Description |
|---|---|---|
offer.created | Offer Created | A credential offer has been created |
offer.retrieved | Offer Retrieved | A recipient has accessed the credential offer |
access_token.created | Access Token Created | A recipient has authenticated |
credential.requested | Credential Requested | A recipient's wallet has requested the credential |
credential.issued | Credential Issued | A credential has been successfully issued |
issuance.error | Issuance Error | An error occurred during issuance |
Credential Verification Events
| Event | Display State | Description |
|---|---|---|
request.created | Request Created | A verification request has been created |
request.retrieved | Request Retrieved | A holder has accessed the verification request |
verification.successful | Verification Successful | Credentials were verified successfully |
verification.error | Verification Error | An error occurred during verification |
Security
- Always use HTTPS endpoints
- Verify webhook signatures to ensure authenticity
- Implement rate limiting and error handling
- Keep your webhook URLs private
Next Steps
- Review the API Reference for detailed endpoint information
- Learn about credential issuance to start issuing credentials
- Set up API Keys for programmatic access