Skip to content
BirlesaBirlesa
Ask or searchSign in
Menu

Event catalog

Every event a webhook can ask for, the organization it goes to, and the ids in its data. The list is also served as JSON: GET /v1/webhook-events. New types may be added; a webhook receives only the types it lists.

EventSent todata idsWhen
match.publishedthe supplier managing the companyneed_id, company_idsA need was matched to companies you manage
match.interestthe buyerneed_id, match_id, company_idA matched supplier is interested in your need
match.outcome_dueboth sidesneed_id, match_idThree weeks after interest: how did it go?
conversation.startedthe supplierconversation_idA buyer started a conversation
message.postedthe other sideconversation_idA new message (read it in the panel)
quote.sentthe buyerconversation_id, quote_idA supplier sent a quote
counter.sentthe supplierconversation_id, quote_idThe buyer answered with a counter-offer
quote.decidedwhoever proposedconversation_id, quote_idA quote or counter-offer was accepted or declined
review.publishedthe supplierconversation_id, review_id, company_idA buyer's review of your company was published
review.reply_publishedthe reviewerconversation_id, review_id, company_idThe supplier replied to your review
review.taken_downthe supplierconversation_id, review_id, company_idA review was taken down after a report
escrow.fundedthe supplierescrow_id, deal_idThe buyer's payment is held in escrow
escrow.deliveredthe buyerescrow_id, deal_idThe supplier reported delivery; release follows unless you object
escrow.releasedthe supplierescrow_id, deal_idMoney was released to you
escrow.refundedthe buyerescrow_id, deal_idMoney was refunded to you
dispute.openedthe other sideescrow_id, deal_id, dispute_idA dispute was opened on the escrow
dispute.withdrawnthe other sideescrow_id, deal_id, dispute_idThe dispute was withdrawn
dispute.settledboth sidesescrow_id, deal_id, dispute_idBirlesa decided how the held money is split
credit.offeredthe buyerescrow_id, deal_idA financing partner made an offer
credit.declinedthe buyerescrow_id, deal_idThe financing partner declined
credit.acceptedthe supplierescrow_id, deal_idThe buyer took the financing offer
service.requestedeach provider askedrequest_idYou were asked for an inspection, test, certification or logistics offer
service.offeredthe requesterrequest_idA provider made an offer
service.acceptedthe providerrequest_idYour offer was accepted
service.reportedthe requesterrequest_idThe provider uploaded the report
shipment.milestoneevery partyshipment_idA shipment reached a key milestone
federation.proposedthe buyerneed_idCompanies abroad were proposed for a need you shared abroad
federation.interestthe company's managercompany_idA buyer abroad is interested in your company (not who)

webhook.test is sent only by the test button and carries no ids.

↵ select↑↓ moveesc close