Webhooks
Recipients Search
This webhook is triggered when a user searches for a recipient. If the registered endpoint answers with a list of contacts, they will be shown in the UI and automatically imported into Proposales when added as a proposal recipient.
It will send a POST
request with search
in the path, containing the URL encoded search terms, and IntegrationSessionData as the body.
The response needs to be in this shape:
{
data: {
uniqueId: string;
email: string;
firstName?: string;
lastName?: string;
isBusiness?: boolean;
phone?: string;
companyName?: string;
metadata?: Record<string, unknown>;
}[]
}
It’s important that uniqueId
is a unique identifier for the contact.