Endpointy
| Metoda | Ścieżka | Opis |
|---|---|---|
| GET | /helpdesk/desks.json |
Lista desków |
| GET | /helpdesk/desks/:id.json |
Pojedynczy desk |
| POST | /helpdesk/desks.json |
Utworzenie desku |
| PATCH | /helpdesk/desks/:id.json |
Aktualizacja desku |
| DELETE | /helpdesk/desks/:id.json |
Usunięcie desku |
Autoryzacja: Authorization: Bearer TOKEN (uprawnienie: helpdesk)
Pola desk
| Pole | Typ | Wymagane | Opis |
|---|---|---|---|
name |
string | tak | Nazwa desku |
description |
text | nie | Opis desku |
color |
string | nie | Kolor HEX (np. #3b82f6) |
active |
boolean | nie | Czy aktywny (domyślnie true) |
attachments_enabled |
boolean | nie | Czy załączniki włączone (domyślnie true) |
locale |
string | nie | Język desku (pl, en, uk, de, fr, es, cs, sk) |
mailbox_id |
integer | nie | ID skrzynki pocztowej |
security_level |
string | nie |
"signature" = wymagaj HMAC |
ticket_pattern |
string | nie | Wzorzec numeracji zgłoszeń |
help_content |
text | nie | Treść pomocy w widgecie |
email_ticket_created_subject |
string | nie | Temat e-maila przy utworzeniu |
email_ticket_created_body |
text | nie | Treść e-maila przy utworzeniu |
email_comment_added_subject |
string | nie | Temat e-maila przy komentarzu |
email_comment_added_body |
text | nie | Treść e-maila przy komentarzu |
default_send_on_create |
boolean | nie | Domyślnie wysyłaj e-mail przy tworzeniu |
default_send_on_comment |
boolean | nie | Domyślnie wysyłaj e-mail przy komentarzu |
Przykład utworzenia
{
"api_token": "TOKEN",
"desk": {
"name": "Support techniczny",
"color": "#3b82f6",
"locale": "pl",
"mailbox_id": 5,
"help_content": "Opisz swój problem jak najdokładniej."
}
}
Odpowiedź
{
"id": 1,
"name": "Support techniczny",
"token": "abc123...",
"color": "#3b82f6",
"active": true,
"attachments_enabled": true,
"tickets_count": 0,
"open_tickets_count": 0,
"unassigned_tickets_count": 0
}
Regeneracja klucza
Aby wygenerować nowy secret_key (dla podpisów HMAC widgetu):
{
"api_token": "TOKEN",
"desk": {
"regenerate_secret_key": "1"
}
}