Webhooks on DreamApply Knowledge Base

How webhooks work

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply uses webhooks to communicate with clients in the following way:

The client subscribes to specific events and sets up a webhook in DreamApply.
When a subscribed event occurs, DreamApply prepares a payload containing event information and related data. The payload uses the same format as the GET /api/journal request.
DreamApply sends a POST request with the payload to the client’s webhook endpoint.
The client receives the data and performs an action, for example, triggers a workflow.
The client returns a success status code to DreamApply to confirm receipt.

To receive event data in JSON format, you must set up an HTTP endpoint that can handle POST requests.

Mon, 01 Jan 0001 00:00:00 +0000

To set up a webhook, you must create a journal, subscribe to the desired events and configure a webhook for that journal.

To set up webhooks, your account must have the Superuser role or the journal-edit, journal-view and api permissions.

To set up a webhook in DreamApply:

Mon, 01 Jan 0001 00:00:00 +0000

DreamApply allows you to resend events to the webhook endpoint. Resending events can be useful in the following scenarios:

You have the following options to resend events:

To manage webhooks, your account must have the Superuser role or the journal-edit, journal-view and api permissions.