Skip to content

Commit

Permalink
Update schema link (#25)
Browse files Browse the repository at this point in the history
* Update schema link

* Remove mention of interactive tool
  • Loading branch information
DLeyland authored Feb 13, 2024
1 parent 36d48ee commit 9ba66ba
Show file tree
Hide file tree
Showing 14 changed files with 14 additions and 16 deletions.
2 changes: 0 additions & 2 deletions api-reference/webhooks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -110,8 +110,6 @@ The request body is a `JSON` object with the fields below.

The JSON schema for Plain the webhook request body can be found [here](https://core-api.uk.plain.com/webhooks/schema.json).

If you prefer, you can browse the schema using [this interactive tool](https://json-schema.app/view/%23?url=https%3A%2F%2Fcore-api.uk.plain.com%2Fwebhooks%2Fschema.json).

| Field | Type | Description |
| ----------------- | -------- | -------------------------------------------------------------------------------------------------------- |
| `id` | `string` | The ID of the Plain event. It remains the same across all of the delivery attempts |
Expand Down
2 changes: 1 addition & 1 deletion api-reference/webhooks/customer-created.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This event is fired when a new customer is created in your workspace.

## Schema

[**View JSON Schema →**](https://json-schema.app/view/%23%2Fdefinitions%2FcustomerCreatedPayload?url=https%3A%2F%2Fcore-api.uk.plain.com%2Fwebhooks%2Fschema.json)
[**View JSON Schema →**](https://core-api.uk.plain.com/webhooks/schema.json)

Example:

Expand Down
2 changes: 1 addition & 1 deletion api-reference/webhooks/customer-deleted.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This event is fired when a customer is deleted from your workspace.

## Schema

[**View JSON Schema →**](https://json-schema.app/view/%23%2Fdefinitions%2FcustomerDeletedPayload?url=https%3A%2F%2Fcore-api.uk.plain.com%2Fwebhooks%2Fschema.json)
[**View JSON Schema →**](https://core-api.uk.plain.com/webhooks/schema.json)

Example:

Expand Down
4 changes: 2 additions & 2 deletions api-reference/webhooks/customer-group-membership-changed.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ title: 'Customer Group Membership Changed Event'

This event is fired whenever a customer is added or removed from a customer group.

The [`changeType`](https://json-schema.app/view/%23%2Fdefinitions%2FcustomerGroupMembershipsChangedPayload?url=https%3A%2F%2Fcore-api.uk.plain.com%2Fwebhooks%2Fschema.json) field allows you to know what kind of change has occurred. It can be one of the following:
The `changeType` field allows you to know what kind of change has occurred. It can be one of the following:

- `ADDED`: a customer group membership was added
- `REMOVED`: a customer group membership was removed

## Schema

[**View JSON Schema →**](https://json-schema.app/view/%23%2Fdefinitions%2FcustomerGroupMembershipsChangedPayload?url=https%3A%2F%2Fcore-api.uk.plain.com%2Fwebhooks%2Fschema.json)
[**View JSON Schema →**](https://core-api.uk.plain.com/webhooks/schema.json)

Example:

Expand Down
2 changes: 1 addition & 1 deletion api-reference/webhooks/customer-updated.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This event is fired when a customer is updated in your workspace. You can expect

## Schema

[**View JSON Schema →**](https://json-schema.app/view/%23%2Fdefinitions%2FcustomerUpdatedPayload?url=https%3A%2F%2Fcore-api.uk.plain.com%2Fwebhooks%2Fschema.json)
[**View JSON Schema →**](https://core-api.uk.plain.com/webhooks/schema.json)

Example:

Expand Down
2 changes: 1 addition & 1 deletion api-reference/webhooks/thread-assignment-transitioned.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This event is fired when the assignee of a thread changes or a thread is unassig

## Schema

[**View JSON Schema →**](https://json-schema.app/view/%23%2Fdefinitions%2FthreadPriorityChangedPayload?url=https%3A%2F%2Fcore-api.uk.plain.com%2Fwebhooks%2Fschema.json)
[**View JSON Schema →**](https://core-api.uk.plain.com/webhooks/schema.json)

Example:

Expand Down
2 changes: 1 addition & 1 deletion api-reference/webhooks/thread-chat-sent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This event is fired when a chat message is sent to a customer in a thread.

## Schema

[**View JSON Schema →**](https://json-schema.app/view/%23%2Fdefinitions%2FthreadChatSentPublicEventPayload?url=https%3A%2F%2Fcore-api.uk.plain.com%2Fwebhooks%2Fschema.json)
[**View JSON Schema →**](https://core-api.uk.plain.com/webhooks/schema.json)

Example:

Expand Down
2 changes: 1 addition & 1 deletion api-reference/webhooks/thread-created.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ You can subscribe to this event if you want to build an [autoresponder](/api-ref

## Schema

[**View JSON Schema →**](https://json-schema.app/view/%23%2Fdefinitions%2FthreadCreatedPayload?url=https%3A%2F%2Fcore-api.uk.plain.com%2Fwebhooks%2Fschema.json)
[**View JSON Schema →**](https://core-api.uk.plain.com/webhooks/schema.json)

Example:

Expand Down
2 changes: 1 addition & 1 deletion api-reference/webhooks/thread-email-received.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This event is fired when an email is received in your workspace.

## Schema

[**View JSON Schema →**](https://json-schema.app/view/%23%2Fdefinitions%2FcustomerCreatedPayload?url=https%3A%2F%2Fcore-api.uk.plain.com%2Fwebhooks%2Fschema.json)
[**View JSON Schema →**](https://core-api.uk.plain.com/webhooks/schema.json)

Example:

Expand Down
2 changes: 1 addition & 1 deletion api-reference/webhooks/thread-email-sent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This event is fired when an email is sent in your workspace.

## Schema

[**View JSON Schema →**](https://json-schema.app/view/%23%2Fdefinitions%2FcustomerCreatedPayload?url=https%3A%2F%2Fcore-api.uk.plain.com%2Fwebhooks%2Fschema.json)
[**View JSON Schema →**](https://core-api.uk.plain.com/webhooks/schema.json)

Example:

Expand Down
2 changes: 1 addition & 1 deletion api-reference/webhooks/thread-labels-changed.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This event is fired when labels are added to or removed from a thread.

## Schema

[**View JSON Schema →**](https://json-schema.app/view/%23%2Fdefinitions%2FthreadLabelsChangedPayload?url=https%3A%2F%2Fcore-api.uk.plain.com%2Fwebhooks%2Fschema.json)
[**View JSON Schema →**](https://core-api.uk.plain.com/webhooks/schema.json)

Example:

Expand Down
2 changes: 1 addition & 1 deletion api-reference/webhooks/thread-note-created.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This event is fired when a note is created in a thread.

## Schema

[**View JSON Schema →**](https://json-schema.app/view/%23%2Fdefinitions%2FthreadNoteCreatedPublicEventPayload?url=https%3A%2F%2Fcore-api.uk.plain.com%2Fwebhooks%2Fschema.json)
[**View JSON Schema →**](https://core-api.uk.plain.com/webhooks/schema.json)

Example:

Expand Down
2 changes: 1 addition & 1 deletion api-reference/webhooks/thread-priority-changed.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This event is fired when the priority of a thread changes.

## Schema

[**View JSON Schema →**](https://json-schema.app/view/%23%2Fdefinitions%2FthreadPriorityChangedPayload?url=https%3A%2F%2Fcore-api.uk.plain.com%2Fwebhooks%2Fschema.json)
[**View JSON Schema →**](https://core-api.uk.plain.com/webhooks/schema.json)

Example:

Expand Down
2 changes: 1 addition & 1 deletion api-reference/webhooks/thread-status-transitioned.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This event is fired when the status of a thread changes.

## Schema

[**View JSON Schema →**](https://json-schema.app/view/%23%2Fdefinitions%2FthreadStatusTransitionedPayload?url=https%3A%2F%2Fcore-api.uk.plain.com%2Fwebhooks%2Fschema.json)
[**View JSON Schema →**](https://core-api.uk.plain.com/webhooks/schema.json)

Example:

Expand Down

0 comments on commit 9ba66ba

Please sign in to comment.