Define a webhook

You have two ways to define a webhook, either in your organization level, or on your workflow level.

Organization

You have to define the notification callback url in the developers section.

Workflow

You have to define the notification callback url preference either when you call the add workflow preferences, or when you use the quick workflow create.

Example

curl --request POST 'https://app.yumisign.com/api/v1/quick/envelopes' \
    --form 'name="Workflow name"' \
    --form 'document=@"/path/to/my/document.pdf"' \
    --form 'type="simple"' \
    --form 'expiryDate="1632819924"' \
    --form 'steps[0][type]="sign"' \
    --form 'steps[0][recipients][0][name]="Recipient name"' \
    --form 'steps[0][recipients][0][email]="recipient@email.com"' \
    --form 'preferences[0][name]="WorkflowMailAttachDocumentPreference"' \
    --form 'preferences[0][value]="0"' \
    --form 'preferences[1][name]="WorkflowNotificationCallbackUrlPreference"' \
    --form 'preferences[1][value]="https://my-site/webhooks/yumisign"'