Resource Ready With Update

webhookresource.ready_with_update

This webhook is triggered when a resource has run successfully and is ready with an update to its data.

About webhook events

This webhook event is sent as a POST request to your configured webhook endpoints when the specified event occurs in your Faraday account. Configure webhook endpoints using the Create webhook endpoint API.

Event payload

When this event occurs, Faraday will send a POST request to your webhook endpoint with the following JSON payload:

dataobjectrequired

The data associated with the event. The structure of this object will depend on the event type.

Properties of object
account_idstring<uuid>required

The ID of the account that owns the resource.

resource_idstring<uuid>required

The ID of the resource that triggered the event.

resource_typestringrequired

The type of a resource which is available via the REST SDK.

Example: "scopes"
Allowed values: accounts, cohorts, connections, datasets, market_opportunity_analyses, outcomes, persona_sets, places, recommenders, scopes, streams, targets, traits
timestampstring<date-time>required
typestringrequired

The type of event that triggered the webhook.

Allowed values: resource.errored, resource.ready_with_update

Example usage

To receive this webhook event, you need to:

  1. Create a webhook endpoint using the Create webhook endpoint API
  2. Ensure your endpoint can receive POST requests with a JSON payload
  3. Verify webhook signatures for security (recommended)
  4. Respond with a 2xx status code to acknowledge receipt of the event