Subscriptions
Subscribe
Create a new subscription on a webhook.
The payload contains the following fields:
eventSource: the name of the webhook to subscribe for. Refer to the Events section to find the list of all available webhooks.targetUrl: the HTTP callback that will receive the webhook payloads.
The response contains the HTTP header Kiflo-Webhook-SigningKey. This is a randomly generated signing key used to sign webhook payloads.
You must store it securely on your end as it will not be returned again.
POST
Subscribe
Body
Request body for creating a webhook subscription.
Available options:
Unknown, ContactNew, ContactUpdate, PartnerNew, PartnerUpdate, PartnerNote, PartnerOnboardingStageUpdate, PartnerApplicationNew, PartnerApplicationAccepted, PartnerApplicationRejected, PartnerOwnerChanged, TeamMemberAdded, TeamMemberDeleted, DealNew, DealUpdate, DealApprovalRequire, DealAccept, DealRefuse, DealNote, DealScheduledRewardValidation, DealAssign, DealStageChange, LeadNew, LeadShare, LeadAccept, LeadRefuse, LeadUpdate, LeadNote, LeadAssign, LeadAbandon, LeadOwnerChanged, LeadNewFromPartnerDirectory, DealExpiration, DealExpirationReminder, RewardNew, CustomerNew, CustomerUpdate, CustomerNote, TransactionNew, TransactionUpdate, ProgramNewPartnerInLevel, PayoutNote, PayoutValidated, PayoutAccepted, PayoutPaid, PayoutNew, PayoutStatusChange, PayoutInvoiceUploaded, TaskDueToday, TaskAssigned, DealQuoteRequested, DealClosedWon, DealOwnerChanged, AssetNew, NewsNew, OnboardingNewPartnerInStage, OnboardingActionWaitingForApproval, OnboardingActionValidated, OnboardingActionInvalidated, TeamMemberCertificationExpired, TeamMemberCertificationExpirationReminder, CommentNew, MentionNew, PartnerStatusUpdated, PartnerProspectionStageUpdated, OnboardingStatusChanged, OnboardingStageStatusChanged, BusinessPlanObjectiveUpdated, PartnerAttachment, LeadAttachment, DealAttachment, CustomerAttachment, TransactionAttachment, PayoutAttachment, CollaborationAttachment, AccountMappingOverlap The HTTP endpoint that will receive the webhook payloads. Must be a publicly accessible HTTPS URL.
Example:
"https://your-app.com/webhooks/kiflo"
Response
200 - application/json
Subscription created. Check the Kiflo-Webhook-SigningKey response header for your signing key.
The response is of type integer<int32>.
