API Documentation Download OpenAPI specification
Notifications

Send Events to Titan

POSThttps://bll.titan.email/partner/notify

Notification APIs should be used post discussion. This is a reference document as to how notifications can be used by a partner. This can be decided upon if there is utility for these notifications

Note :

  • HOSTING_PURCHASED
    • This Event notifies Titan that a hosting plan has been purchased at partner's end and the user is eligible for a Titan plan. This information helps in tracking the signup (attach) rates.
  • REFUND_ISSUED
    • This Event notifies Titan that a refund has been issued from partner to the customer.
    • Event can be called for active/suspended/deleted mail order.
    • If API is called multiple times with same paymentTxnId and different data (domainName, refundAmount refundTaxAmount, refundUSDAmount and currency), partner will get BAD_REQUEST exception else no action is taken.
    • If paymentTxnId is not sent, Titan records each call as a new refund.
  • MAIL_ORDER_SETUP_COMPLETED
    • On this API notification Titan will mark order's setup as completed and stop showing relevant upgrade/purchase hooks
  • MAIL_ORDER_PURCHASED
    • This Event notifies Titan that mail order is purchased and contains details related to transaction.
    • This Event is only used for reference and reporting on Titan's end.
  • PAYMENT_DATA_BULK
    • This Event notifies Titan of the customer's purchase of standalone email order / additional mailbox purchases / Titan order upgrades / Titan order renewals.
    • Max batch size of the event is 100 orders
  • REFUND_ISSUED_BULK
    • This Event notifies Titan that a refund has been issued from partner to the customer in bulk.
    • Max batch size of the event is 100 orders.
  • CREDIT_ISSUED
    • This Event notifies Titan that a credit has been issued from partner to the customer.
  • MAIL_ORDER_PURCHASE_CANCELED
    • This Event notifies Titan that mail order is canceled at partner's end. Titan only records this event and does not change the mail order.
    • Send this event when user has purchased standalone email plan, does not setup the email during plan duration and doesn't renew on plan expiry.
  • MODIFY_MAIL_ORDER_DETAILS
    • This Event notifies Titan that the payment method or the auto-renew setting of a mail order has been modified.

Body

application/json
eventstringrequired

event name

Example: MAIL_ORDER_SETUP_COMPLETED
dataobjectrequired

event data in json

Responses

200OKapplication/json
reqIDstringrequired
400BAD_REQUEST
  • If REFUND_ISSUED is called multiple times with same paymentTxnId and different data (domainName, refundAmount refundTaxAmount, refundUSDAmount and currency), partner will get BAD_REQUEST exception.
See General Errors for other errors that this API can return.
POST/partner/notify
curl https://bll.titan.email/partner/notify \
  --request POST \
  --header 'Authorization: API.Key' \
  --header 'Content-Type: application/json' \
  --data '{
  "event": "MAIL_ORDER_SETUP_COMPLETED",
  "data": {}
}'
Response
{
  "reqID": "string"
}