---
title: "Social media report ready"
method: POST
path: "reportEvents_webhook-report-social-media-ready"
---

# Social media report ready

`POST reportEvents_webhook-report-social-media-ready` (webhook)

Webhook for the `report/social-media.ready` event. For more info see [Webhooks Overview](https://docs.withpersona.com/webhooks).

Sent when a social media report finishes processing and its results are available (`status` is `ready`).

The payload is the polymorphic report object. Inspect `payload.data.type` (`report/social-media`) to identify the report, and `payload.data.attributes` for its inputs and results.

## Headers

- `Persona-Signature` string
- `Persona-Webhook-Attempts-Made` integer
- `Persona-Webhook-Attempts-Left` integer
- `Persona-Webhook-First-Attempted-At` integer

## Payload

- object
  - `data` WebhooksWebhookReportSocialMediaReadyPayloadContentApplicationJsonSchemaData
    - `type` 'event'
    - `id` string: Unique identifier for this Event. Starts with `evt_`.
    - `attributes` WebhooksWebhookReportSocialMediaReadyPayloadContentApplicationJsonSchemaDataAttributes
      - `created-at` string, date-time: Datetime when the event was created.
      - `name` 'report/social-media.ready'
      - `payload` WebhooksWebhookReportSocialMediaReadyPayloadContentApplicationJsonSchemaDataAttributesPayload
        - `data` ReportSocialMedia: A Social Media Report
          - `id` string: The ID of the report
          - `attributes` ReportDiscriminatorMappingReportSocialMediaAttributes
            - `status` string: The status of the report Possible values: - pending - ready - errored Do not assume this is a static enumeration; Persona may add new values in the future without a versioned update.
            - `created-at` string: The time the report was created in ISO 8601 format
            - `completed-at` string, nullable: The time the report completed processing in ISO 8601 format
            - `redacted-at` string, nullable: The time the report was redacted in ISO 8601 format
            - `report-template-version-name` string: The name of the report template version used for this report
            - `has-match` boolean: Whether or not the report matched
            - `is-continuous` boolean: Whether or not this report has been run more than once
            - `is-recurring` boolean: Whether or not this report is scheduled to run in the future
            - `tags` string[]: Tags on the report
            - `name-first` string, nullable
            - `name-last` string, nullable
            - `birthdate` string: Date of birth in YYYY-MM-DD format
            - `phone-number` string, nullable
            - `email-address` string, nullable
            - `address-city` string, nullable
            - `address-subdivision` string, nullable: Sub-national subdivision such as a US state or a Canadian province
            - `linkedin-url` string, nullable
            - `linkedin-username` string, nullable
            - `linkedin-id` string, nullable
            - `facebook-url` string, nullable
            - `facebook-username` string, nullable
            - `facebook-id` string, nullable
            - `twitter-url` string, nullable
            - `twitter-username` string, nullable
            - `github-url` string, nullable
            - `github-username` string, nullable
            - `instagram-url` string, nullable
            - `instagram-username` string, nullable
          - `relationships` ReportSharedRelationships: Other Persona objects related to the report
            - `inquiry` ReportSharedRelationshipsInquiry: The inquiry linked to the report
              - …
            - `account` ReportSharedRelationshipsAccount: The report's home account, or the first linked account when it has no home account. It returns only one account and is kept for backwards compatibility; use `accounts` to see every associated account. Including it does not require the `account.read` permission.
              - …
            - `accounts` ReportSharedRelationshipsAccounts: Every account associated with the report, meaning its home account plus all linked accounts, deduplicated and listed in account creation order. Use this when a report can be linked to more than one account; `account` is kept for backwards compatibility and returns only one. The list is not paginated or capped, and is empty when the report has no accounts. Expanding it with `include=accounts` requires the `account.read` permission; the linkage ids do not.
              - …
            - `transaction` ReportSharedRelationshipsTransaction: The transaction linked to the report
              - …
            - `report-template` ReportSharedRelationshipsReportTemplate: The report template used to create this report
              - …
        - `included` ReportsIncludedObjectsItems[]
          - union
            - object: An Inquiry object
              - …
            - object: An Account object. Note that `fields` is **not** key inflected.
              - …
            - object: An Address Lookup Report Template
              - …
            - object: An Adverse Media Report Template
              - …
            - object: A Business Adverse Media Report Template
              - …
            - object: A Business Associated Persons Report Template
              - …
            - object: A Business Lookup Report Template
              - …
            - object: A Business Media Coverage Report Template
              - …
            - object: A Business Nonprofit Report Template
              - …
            - object: A Business Registrations Lookup Report Template
              - …
            - object: A Business Watchlist Report Template
              - …
            - object: A Crypto Address Watchlist Report Template
              - …
            - object: An Email Address Report Template
              - …
            - object: A Phone Risk Report Template
              - …
            - object: A Politically Exposed Person Report Template
              - …
            - object: A Profile Report Template
              - …
            - object: A Screening Report Template
              - …
            - object: A SentiLink Report Template
              - …
            - object: A Social Media Report Template
              - …
            - object: A Synthetic Template
              - …
            - object: A Watchlist Report Template
              - …
            - object: transaction variant
              - …

## Acknowledgement `200`

Webhook received successfully

---

[API](https://skmtc.dev/withpersona/apis/withpersona-8.md) - [All operations](https://skmtc.dev/withpersona/apis/withpersona-8/llms.txt) - [OpenAPI document](https://skmtc.dev/withpersona/apis/withpersona-8/revisions/3683a7f9e1fe?raw)
