You've Got Leads API

Webhook

A webhook lets YGL send data to your system automatically when a business event happens.

Examples: when a new lead is created, when a task is completed, or when a lead status changes, YGL can send an HTTP POST request to your URL.

Only organization-level integration users can view or manage webhooks. Referral source users cannot use these endpoints.

Requests

Request/Response Objects

The main object used by these endpoints is the Webhook object.

A webhook defines which event YGL should watch, which property it belongs to, and where YGL should send the outbound POST request.

Important: use the website-specific events endpoint to decide which Event values can be used for the selected WebSite.

Required Fields for POST

The following fields are required when creating a webhook:

• PropertyId: the property the webhook belongs to
• Event: the event name returned by https://partner-api.youvegotleads.com/api/webhooks/eventsByWebSite?webSite=...
• TargetUrl: the destination URL that will receive the POST request
• WebSite: the integration target name, such as Zapier, NGrok, or your custom integration website

AuthenticationType, AuthenticationKey, and TriggerData are optional.

Webhooks

Sample GET Requests

Sample EventsByWebSite Request

Sample EventsByWebSite Response

Use this endpoint to load the supported website definition and event list for a selected website in the client.

{
    "Website": "NGrok",
    "SupportedEvents": ["NewLead", "NewTask", "LeadStatusChanged", "LeadMovedIn", "DepositMade", "ScheduledMove", "LeadMovedOut", "LeadClosed", "PreTour", "PostTour", "CompleteTask", "NewTourTask"],
    "Notes": "Supports all webhook events for testing and generic integrations."
}

Sample GET Response

[
    {
        "PropertyId": 141069,
        "Id": 1044,
        "Event": "NewTask",
        "TargetUrl": "https://sample.com/api/v1/webhooks/tasks",
        "WebSite": "NGrok",
        "CreatedOn": "2024-12-10T06:24:42.66",
        "AuthenticationType": 1,
        "AuthenticationKey": "Bearer sampleAuth",
        "TriggerData": "{\"task_TaskTypeId\":[\"29\",\"31\"]}"
    },
    {
        "PropertyId": 141069,
        "Id": 1045,
        "Event": "CompleteTask",
        "TargetUrl": "https://sample.com/api/v1/webhooks/tasks",
        "WebSite": "NGrok",
        "CreatedOn": "2024-12-10T06:38:19.873",
        "AuthenticationType": 1,
        "AuthenticationKey": "Bearer sampleAuth",
        "TriggerData": "{\"task_TaskTypeId\":[\"29\",\"31\",\"33\"]}"
    }
]

Sample POST Request

Include all required fields in the JSON body. Optional fields may be omitted if you do not use them.

{
    "PropertyId": 141069,
    "Event": "CompleteTask",
    "TargetUrl": "https://sample.com/api/v1/webhooks/tasks",
    "WebSite": "NGrok",
    "AuthenticationType": 1,
    "AuthenticationKey": "Bearer sampleAuth",
    "TriggerData": "{\"task_TaskTypeId\":[\"29\",\"31\",\"33\"]}"
}

Sample POST Response

If the webhook is created successfully, the API returns HTTP 201 and the created object. If creation fails, review the response body for the reason.

{
    "PropertyId": 141069,
    "Id": 3057,
    "Event": "CompleteTask",
    "TargetUrl": "https://sample.com/api/v1/webhooks/tasks",
    "WebSite": "NGrok",
    "CreatedOn": "2025-09-02T07:27:29.918762Z",
    "AuthenticationType": 1,
    "AuthenticationKey": "Bearer sampleAuth",
    "TriggerData": "{\"task_TaskTypeId\":[\"29\",\"31\",\"33\"]}"
}

Sample PUT Request

Send the full set of updatable fields in the PUT body. If you leave out an updatable field, it may be overwritten.

{
    "PropertyId": 141069,
    "Event": "CompleteTask",
    "TargetUrl": "https://sample.com/api/v1/webhooks/tasks",
    "WebSite": "NGrok",
    "AuthenticationType": 1,
    "AuthenticationKey": "Bearer updatedSampleAuth",
    "TriggerData": "{\"task_TaskTypeId\":[\"29\",\"31\",\"33\"]}"
}

Sample PUT Response

If the update succeeds, the API returns HTTP 200 and the updated object.

{
    "PropertyId": 141069,
    "Id": 3057,
    "Event": "CompleteTask",
    "TargetUrl": "https://sample.com/api/v1/webhooks/tasks",
    "WebSite": "NGrok",
    "CreatedOn": "2025-09-02T07:27:29.918762Z",
    "AuthenticationType": 1,
    "AuthenticationKey": "Bearer updatedSampleAuth",
    "TriggerData": "{\"task_TaskTypeId\":[\"29\",\"31\",\"33\"]}"
}

Common Error Responses