Article Webhook

Receive newly found articles from the Horizon Scanner in real time.

1. Article Webhook Configuration

Article webhooks let you ingest newly found articles from the Horizon Scanner.

To configure:

  1. Go to Settings > Webhooks > Article Webhook.

  2. Fill in the fields below and enable the webhook.

  3. (Recommended) Click Send Test Payload to verify your configuration.

Field
Description

Enable Article Webhook

Enables or disables the webhook.

Webhook URL

The publicly accessible HTTPS endpoint Graceview will call when an article is processed.

Authentication Header Name

Name of the HTTP header used for bearer token authentication. This is usually Authorization.

Authentication Header Token

The value of the secret token.

Once enabled, new items found and processed by the Horizon Scanner will be sent to your endpoint automatically.

2. Article Webhook Object

Represents an event triggered when the Horizon Scanner processes an article.

2.1 Structure

Field
Type
Description

payload_id

Unique ID

ID of the event that triggered the webhook.

ulid

ULID

Unique, 26‑character ID of the article.

title

String

Title of the article.

date

Date

Date provided by the original source.

found

DateTime

Timestamp of when the Horizon Scanner processed the article.

content_type

Content Type Resource

Content type of the article.

metadata

Metadata Resource

Metadata attached to the article.

materials

Array of Materials Resource

Source materials linked to the article. May be empty.

2.2 Metadata Resource

Represents metadata on an article.

Field
Type
Description

properties

Properties Resource

Contains area of law and location details.

2.2.1 Properties Resource

Field
Type
Description

areas_of_law

Array of Area of Law Resources

Areas of law applied to this article.

locations

Array of Location Resources

Locations associated with this article.

2.2.2 Area of Law Resource

Field
Type
Description

id

ULID

Unique ID of the area of law

value

String

Name of the area of law

2.3 Location Resource

Represents a location.

Field
Type
Description

location_type

Enum

national or multinational.

state

Object

Contains code and name properties for a state, if applicable.

country

Object

Contains code and name properties for a country, if applicable.

association

Object

Contains id, name, and countries representing an association, if applicable.

2.4 Materials Resource

Represents source materials linked to the article. The array may be empty.

Field
Type
Description

id

ULID

Unique ID of the material entry.

title

String

Title of the material.

type

String

Material type (for example email, document, link).

link

String

URL to the material. Document and email materials use signed download links.

date

Date

Date associated with the material.

description

String

Description of the material, if provided.

location

Location Resource | []

Optional location object. Empty array when no location is set.

2.5 Content Type Resource

Represents a content type.

Field
Type
Description

id

String

ID of the content type

value

String

Name of the content type

3. Delivery

  • Method: HTTP POST with a JSON body.

  • Auth: Graceview includes your configured authentication header in requests.

  • Acknowledgement: Respond with 2xx to confirm receipt.

  • Retries: If no 2xx is received, Graceview retries up to 5 times with exponential backoff.

  • Idempotency: Use payload_id to deduplicate events.

Last updated