Webhooks
Create a Webhook
Creates a new webhook, consisting of a pushUrl and a event type. For a list of all possible types use the GET /api/sales-partners/subscribable-event-types.
post/sales-partners/webhooks
Request body
pushUrlstring required
URL to receive webhooks
type'ADMIN_ALERT' | 'BRAND_DATA_POINT_REPLIED' | 'BRAND_DATA_POINT_REPLIED_PENDING_APPROVAL' | 'BRAND_DATA_POINT_REPLY_APPROVE' | 'BRAND_DATA_POINT_REPLY_REJECT' | 'BUSINESS_CHAIN_UPDATE' | 'BUSINESS_CHANGED_SALES_PARTNER' | 'BUSINESS_COMMENT' | 'BUSINESS_CREATED' | 'BUSINESS_CSV_EXPORT' | 'BUSINESS_DIRECTORY_ACCOUNT' | 'BUSINESS_DIRECTORY_CONNECT' | 'BUSINESS_DUPLICATE_CHECK' | 'BUSINESS_FACEBOOK_PAGE_INVALIDATE' | 'BUSINESS_INVOICE_CHANGED' | 'BUSINESS_INVOICE_CREATED' | 'BUSINESS_INVOICE_CREATED_ANOTHER_BASIC' | 'BUSINESS_INVOICE_CREATED_ANOTHER_PREMIUM' | 'BUSINESS_INVOICE_CREATED_FIRST_BASIC' | 'BUSINESS_INVOICE_CREATED_FIRST_PREMIUM' | 'BUSINESS_INVOICE_CREATED_RENEWAL' | 'BUSINESS_INVOICE_CREATED_UPGRADE_BASIC' | 'BUSINESS_INVOICE_CREATED_UPGRADE_PREMIUM' | 'BUSINESS_INVOICE_RENEWAL_FAIL' | 'BUSINESS_INVOICE_RENEWAL_SUCCESS' | 'BUSINESS_LOCATION_DATA_PULL' | 'BUSINESS_MIGRATE_LOCATION' | 'BUSINESS_NEW_CHATS' | 'BUSINESS_NEW_CONTACT_FORM' | 'BUSINESS_OLO_IMPORT' | 'BUSINESS_OLO_SETTINGS_CREATED' | 'BUSINESS_OLO_SETTINGS_DELETED' | 'BUSINESS_OLO_SETTINGS_UPDATED' | 'BUSINESS_PAGE_INVALIDATE' | 'BUSINESS_PAY_INVOICE' | 'BUSINESS_PRODUCT_PLAN_CHANGED' | 'BUSINESS_STATUS_CHANGED' | 'BUSINESS_TEMPLATE_UPDATE' | 'BUSINESS_UPDATE_PAGE_SOCIAL_POST' | 'BUSINESS_UPDATE_PRICE' | 'DATA_POINT_AUTOMATED_REPLY' | 'DATA_POINT_REPLIED' | 'DATA_POINT_REPLIED_PENDING_APPROVAL' | 'DATA_POINT_REPLY_APPROVE' | 'DATA_POINT_REPLY_REJECT' | 'DATA_POINT_SERVICE_NOW_SUBMITTED' | 'DIRECTORY_BUSINESS_PAGE_DATA_POINT_CHECK' | 'DIRECTORY_BUSINESS_PAGE_DATA_POINT_INVALID' | 'DIRECTORY_USER_ACCOUNT_DIRECTORY_CONNECT' | 'LISTING_AUTOVALIDATION_FAILED' | 'LISTING_BLACKLIST' | 'LISTING_CANCEL' | 'LISTING_DATAPOINT_CHECK' | 'LISTING_DATAPOINT_INVALID' | 'LISTING_DELETE' | 'LISTING_DIRECTORY_CONNECT' | 'LISTING_DIRECTORY_DUPLICATE_REMOVED' | 'LISTING_FACEBOOK_PAGE_INVALIDATE' | 'LISTING_FEED_CREATE' | 'LISTING_FEED_DUPLICATE_REMOVED' | 'LISTING_FEED_IN_SYNC_FIELDS' | 'LISTING_FLAGGED' | 'LISTING_GOOGLE_PAGE_CREATE' | 'LISTING_GOOGLE_PAGE_INVALIDATE' | 'LISTING_GOOGLE_PAGE_UPDATE' | 'LISTING_INITIATE_OWNERSHIP_TRANSFER' | 'LISTING_INVITATION_SENT' | 'LISTING_LINK_CHANGE' | 'LISTING_MANUAL' | 'LISTING_NEEDS_REVIEW_DELETED' | 'LISTING_PAGE_INVALIDATE' | 'LISTING_PUBLISHER_UPDATE' | 'LISTING_REMOVAL_STATUS_CHECK' | 'LISTING_REMOVAL_SUPPRESS' | 'LISTING_REVIEWED' | 'LISTING_STATUS_CHANGE' | 'LISTING_SUGGESTION' | 'LISTING_SUPPRESS' | 'LISTING_SUPPRESS_NOT_ALLOWED' | 'LISTING_SYNC_CHECK' | 'LISTING_UPDATE' | 'LISTING_UPDATE_PAGE_SOCIAL_POST' | 'LISTING_UPDATE_SOCIAL_POST' | 'LISTING_WAITING_DIRECTORY_ACTION' | 'LOCATION_BILLING' | 'LOCATION_BUSINESS_CHANGED' | 'LOCATION_CHECKOUT' | 'LOCATION_CHECKOUT_FREE' | 'LOCATION_CHECKOUT_SALESPARTNER' | 'LOCATION_CHECKOUT_UPGRADE' | 'LOCATION_CLEANSING' | 'LOCATION_CONTRACT_UPDATED' | 'LOCATION_CREATED' | 'LOCATION_DUPLICATE_LISTING_CHECK' | 'LOCATION_DUPLICATE_LISTING_DETECTION' | 'LOCATION_FEED_CLOSED' | 'LOCATION_FEED_PROFILE_CHANGED' | 'LOCATION_GEOCODING_MANUAL' | 'LOCATION_GOOGLE_RANK_CHECK' | 'LOCATION_GROUP_CREATED' | 'LOCATION_GROUP_DELETED' | 'LOCATION_GROUP_UPDATED' | 'LOCATION_INVOICE_CHANGED' | 'LOCATION_LISTING_ADDED' | 'LOCATION_NEEDS_REVIEW_DELETED' | 'LOCATION_NEW_CHATS' | 'LOCATION_NEW_CONTACT_FORM' | 'LOCATION_NORMALIZATION_STATUS_CHANGED' | 'LOCATION_OLO_IMPORT' | 'LOCATION_PARTIAL_UPDATE' | 'LOCATION_PAY_INVOICE' | 'LOCATION_PROFILE_CHANGED' | 'LOCATION_PROFILE_SUGGESTION_DECLINE' | 'LOCATION_STATUS_CHANGED' | 'LOCATION_SUBSCRIPTION_CHANGED' | 'LOCATION_SUGGESTION_CREATED' | 'LOCATION_SUGGESTION_UPDATED' | 'LOCATION_SYNC_CHECK' | 'LOCATION_SYNC_STARTED' | 'LOCATION_VISIBILITY_INDEX_CHANGED' | 'PEON_MANUAL_ENQUEUE' | 'PRODUCT_PLAN_CREATED' | 'PRODUCT_PLAN_DELETED' | 'PRODUCT_PLAN_UPDATED' | 'SALES_PARTNER_APPROVAL' | 'SALES_PARTNER_CHILDREN_UPDATED' | 'SALES_PARTNER_CREATED' | 'SALES_PARTNER_DIRECTORY_BRAND' | 'SALES_PARTNER_DIRECTORY_CONNECT' | 'SALES_PARTNER_ENTERPRISE_ONBOARDING' | 'SALES_PARTNER_INVOICE_CHANGED' | 'SALES_PARTNER_INVOICE_PAYMENT_INFORMATION_CHANGED' | 'SALES_PARTNER_ONE_AND_ONE_AUTHENTICATION' | 'SALES_PARTNER_ONE_AND_ONE_CONTRACT_INFORMATION' | 'SALES_PARTNER_PASSWORD_RESET' | 'SALES_PARTNER_PAYMENT_METHOD_RESET' | 'SALES_PARTNER_PAY_INVOICE' | 'SALES_PARTNER_REPRESENTATIVE_UPDATE' | 'SALES_PARTNER_SIGNUP' | 'SALES_PARTNER_STATUS_CHANGED' | 'SALES_PARTNER_TYPE_CHANGED' | 'SALES_PARTNER_UPDATED' | 'SALES_REPRESENTATIVE_UPDATE' | 'SEARCH_DATA_RECHECK_LINK_SHARED' | 'USER_ACTIVATION_EMAIL_SENT' | 'USER_DASHBOARD_EXPORT_COMPLETE' | 'USER_DIGEST_EMAIL_SENT' | 'USER_FINISH_VERIFICATION_GOOGLE_EMAIL_SENT' | 'USER_INVITATION' | 'USER_INVITATION_EMAIL_SENT' | 'USER_INVOICE_INVITATION' | 'USER_MODIFY_EMAIL_SETTING' | 'USER_NOTIFICATION_EMAIL_SENT' | 'USER_PASSWORD_RESET' | 'USER_PENDING_APPROVAL_REPLY_NOTIFICATION_EMAIL_SENT' | 'USER_READ_DATA_POINT' | 'USER_START_VERIFICATION_GOOGLE_EMAIL_SENT' | 'USER_STATUS_CHANGED' | 'USER_TIER1_EMAIL_SENT' | 'USER_TIER2_EMAIL_SENT' | 'USER_TIER3_EMAIL_SENT' | 'USER_UNREAD_DATA_POINT' | 'USER_UNREAD_REVIEW_NOTIFICATION_EMAIL_SENT' | 'USER_UPDATED' | 'USER_SOCIAL_POST_PENDING_APPROVAL_EMAIL_SENT' | 'WIDGET_CONFIG_CREATED' | 'WIDGET_CONFIG_DELETED' | 'WIDGET_CONFIG_PUBLISHED' | 'SOCIAL_POST_PENDING_APPROVAL' required
Logging event type to subscribe to
Response
Successfully created webhook