Publisher Webhook

Receive content published from your workspace in real time.

1. Publisher Webhook Configuration

Publisher webhooks let you ingest content published from your workspace.

To configure:

  1. Go to Settings > Webhooks > Publisher Webhook.

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

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

Field
Description

Enable Publisher Webhook

Enables or disables the webhook.

Webhook URL

The publicly accessible HTTPS endpoint Graceview will call when content is published.

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, you will see a Publish via API checkbox when publishing content in Graceview. When this checkbox is ticked and you click Publish, Graceview sends the payload to your endpoint.

2. Publisher Webhook Object

Represents a webhook event triggered by publishing content.

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 content.

title

String

Title of the content.

date

Date

Date of the original source.

published_at

DateTime

Timestamp of when the content was published.

version

String

Version of the current published content revision.

publisher

User Resource

The user that published the content.

metadata

Metadata Resource

Metadata attached to the content.

content

Array of Content Resources

Richtext fields on the content.

events

Events Resource

Timeline on the content.

attachments

Attachments Resource

Attachments on the content.

2.2 User Resource

Represents the user who performed the publish action.

Field
Type
Description

email

String

Email associated with the user account.

first_name

String

User’s first name.

last_name

String

User’s last name.

2.3 Metadata Resource

Represents metadata on a page or event.

Field
Type
Description

Properties

Properties Resource

Contains area of law and location information.

Labels

Array of Labels Resources

Array of label resources.

2.3.1 Properties Resource

Holds area of law and location arrays.

Field
Type
Description

areas_of_law

Array of Area of Law Resources

Areas of law applied to this content.

locations

Array of Location Resources

Locations associated with this content.

2.3.2 Labels Resource

Represents a single label entry.

Field
Type
Description

id

ULID

Unique ID of the label

name

String

Name of the label.

type

Enum

select, text, multi_select, or toggle.

values

Array

Value of the label.

2.3.3 Area of Law Resource

Represents an area of law.

Field
Type
Description

id

ULID

Unique ID of the Area of Law.

value

String

Value (name) of the Area of Law.

2.4 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.5 Content Resource

Represents the rich text sections of a page or event.

Field
Type
Description

id

ULID

Unique ID representing the block.

name

String

The name of the block (for example Executive Summary, Applicability).

value

String

Markup content of the block.

2.6 Events Resource

Represents events on a page or event.

Field
Type
Description

name

String

Name of the events block

values

Array of EventValue Resources

Array of event entries.

2.6.1 EventValue Resource

A single event in the events array.

Field
Type
Description

id

ULID

Unique ID of the event entry.

title

String

Title of the event.

start_date

Date

Event start date.

end_date

?Date

Event end date; can be null.

content_type

Content Type Resource

A content type object.

priority

Enum

low, medium, high.

location

Location Resource

A location object.

2.7 Attachment Resource

Represents attachments on a page or event.

Field
Type
Description

name

String

Name of the attachment block.

value

Array of AttachmentValue Resources

Array of attachment entries.

2.7.1 AttachmentValue Resource

A single attachment in the attachments array.

Field
Type
Description

id

ULID

Unique ID of the attachment entry.

title

String

Title of the attachment entry.

type

Enum

link or document.

link

String

URL pointing to a source or a signed document download link.

date

Date

Date associated with the attachment.

location

Location Resource

A location object.

content_type

Content Type Resource

A content type object.

2.8 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