selfhosted
/
pasty
mirror of https://github.com/lus/pasty.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Document the report webhook

This commit is contained in:
Lukas Schulte Pelkum 2021-07-23 23:37:13 +02:00
parent 9dfcd1788d
commit dd85d64c1c
No known key found for this signature in database
GPG Key ID: 408DA7CA81DB885C
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
API.md
View File

@ -173,9 +173,12 @@ POST /api/v2/pastes/{paste_id}/report
**Response:**
```jsonc
{
"success": true, // Whether or not the report was received successfully (this is returned by the report webhook to allow custom errors)
"message": "message" // An optional message to display to the reporting user
}
```
**Notes:**
* The endpoint is only available if the report system is enabled. Otherwise it will return a `404 Not Found` error.
* The endpoint is only available if the report system is enabled. Otherwise it will return a `404 Not Found` error.
* The request for this endpoint is the exact same that will reach the webhook.
* The response from this endpoint is the exact same that pasty expects from the webhook.