Sendoso API home page
Search...
⌘K
Getting Started
Introduction
Events
Endpoints
Security
Retries
Troubleshooting
Tech Radar
Support
Sendoso API home page
Search...
⌘K
Tech Radar
Support
Search...
Navigation
Getting Started
Events
Sendoso Core API
SCIM API
SmartSend / Marketplace API
iFrame
Webhooks
Sendoso Core API
SCIM API
SmartSend / Marketplace API
iFrame
Webhooks
Getting Started
Events
Each webhook has an associated event type. The events that are triggered reflect what is seen in the send tracker. You can subscribe to any or all of the following event types within your webhooks portal.
Event Types
send.amazon_fulfilling
Triggered when the Amazon send is being processed.
send.amazon_shipped
Triggered when the send has shipped from Amazon and is in transit to Sendoso.
send.blocked
Triggered when a request to redeem the send has been blocked.
send.bounced
Triggered when the send cannot be redeemed and will be refunded.
send.canceled
Triggered when the send has been canceled by the sender.
send.clicked
Triggered when the eGift send has been viewed by the recipient.
send.confirmation_canceled
Triggered when address confirmation for a send has been canceled by the sender.
send.confirming_address
Triggered when the send is awaiting address confirmation from the recipient.
send.delivered
Triggered when the send has been delivered to the recipient.
send.email_blacklist
Triggered when a request to redeem the send has been blacklisted.
send.expired
Triggered when the link to redeem the send has expired.
send.failed
Triggered when the send has failed.
send.fulfilling
Triggered when the send is being processed by Sendoso.
send.fulfillment_issue
Triggered when there is an issue on the fulfillment side for the send.
send.initiated
Triggered when the send is in the process of being created.
send.insufficient_funds
Triggered when the send cannot be processed due to insufficient funds.
send.invalid_email_format
Triggered when the recipient email in the send is not a valid email.
send.opened
Triggered when the eGift send has been opened by the recipient.
send.order_received
Triggered when the send order has been received and is being processed.
send.out_of_stock
Triggered when the product for the send is out of stock.
send.pending_approval
Triggered when the send is pending approval by the sender.
send.pending_sendoso_approval
Triggered when the send is pending approval by a Sendoso Admin.
send.redeemed
Triggered when the eGift send has been redeemed by the recipient.
send.refunded
Triggered when the send has been refunded.
send.sent
Triggered when the eGift send has been sent to the recipient.
send.shipped
Triggered when the send is in transit to the recipient.
send.suspicious_email
Triggered when the recipient email for the send is flagged as suspicious.
send.undeliverable
Triggered when the send cannot be delivered to the recipient.
Schema
The schema (payload) for all event types will be:
Copy
{
"send_gid": "<string>"
"status_changed_at": "<string>"
}
send_gid
string
The gid of the send.
status_changed_at
string
The time at which the send’s status was changed in ISO 8601 format.
Previous
Endpoints
Next
On this page
Event Types
send.amazon_fulfilling
send.amazon_shipped
send.blocked
send.bounced
send.canceled
send.clicked
send.confirmation_canceled
send.confirming_address
send.delivered
send.email_blacklist
send.expired
send.failed
send.fulfilling
send.fulfillment_issue
send.initiated
send.insufficient_funds
send.invalid_email_format
send.opened
send.order_received
send.out_of_stock
send.pending_approval
send.pending_sendoso_approval
send.redeemed
send.refunded
send.sent
send.shipped
send.suspicious_email
send.undeliverable
Schema
Assistant
Responses are generated using AI and may contain mistakes.