Represents a REST hook subscribed to events in Capsule.
| Name | Type | Description | |
|---|---|---|---|
| id | Long | Read only |
The unique id of the REST hook. |
| user | Nested User | Read only |
The user that created this REST hook. |
| clientId | Integer | Read only |
The unique id of the client managing the REST hook. |
| description | String |
A description of the hook. |
|
| event | String | Required |
The event in Capsule this hook is subscribed to e.g |
| targetUrl | String | Required |
The URL that Capsule should notify of events. |
| embed | String |
Which fields should be embedded in the JSON response e.g |
|
| createdAt | Date | Read only |
The ISO date/time when this REST hook was created. |
| updatedAt | Date | Read only |
The ISO date/time when the REST hook was last updated. |