Webhook Events Overview

The Everee platform sends notifications when certain events occur. These notifications are webhook events published to an endpoint listening for these events in your platform.

During account configuration, you can provide a Target URL—an HTTPS URL that will receive webhook event payloads—to enable webhook delivery from Everee to your platform. Talk to your Partner Success manager about enabling webhook events.

When a webhook event is sent to your target URL, the payload has the following structure:

{
        id: string, unique ID of the event
        companyId: number, unique ID of the client Company instance in Everee
        type: string, event type name (see above)
        timestamp: number, epoch timestamp of the event’s occurrence
        data: object, with shape: {
              object: object, with shape: {
                    [relevant object structure; see below]
              }
        }
        version: string, version of the payload structure; currently always "1"
}

Worker Onboarding Completed

This event is sent when a worker has completed onboarding in Everee and is ready to receive funds.

Webhook event type: worker.onboarding-completed
Webhook event data.object has the following structure:

{
    "workerId": "workerId",
    "externalWorkerId": "externalWorkerId",
    "onboardingStatus": "COMPLETE",
    "onboardingComplete": true
}

Payment Deposit Returned

This event is sent when a payment deposit has been rejected by the destination bank.

This is most often due to an incorrect account/routing number in Everee. The client should prompt the worker to update their account/routing number information. When account/routing number information has been updated, Everee will automatically retry the deposit as soon as possible.

Webhook event type: payment.deposit-returned
Webhook event data.object has the following structure:

{
    "workerId": "workerId",
    "externalWorkerId": "externalWorkerId",
    "paymentId": 123456789
}