Skip to content

Commit 3a9d0db

Browse files
jesushernandezjesushernandez
committed
Updated with new webhook schema
1 parent d05f206 commit 3a9d0db

File tree

3 files changed

+332
-2
lines changed

3 files changed

+332
-2
lines changed

‎.changeset/witty-lizards-sleep.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@team-plain/typescript-sdk': patch
3+
---
4+
5+
Updated webhook schema

‎src/webhooks/webhook-schema.json‎

Lines changed: 263 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,9 @@
5555
{
5656
"$ref": "#/definitions/threadChatSentPublicEventPayload"
5757
},
58+
{
59+
"$ref": "#/definitions/threadServiceLevelAgreementStatusTransitionedPayload"
60+
},
5861
{
5962
"$ref": "#/definitions/customerCreatedPublicEventPayload"
6063
},
@@ -84,6 +87,7 @@
8487
"thread.thread_field_created",
8588
"thread.thread_field_updated",
8689
"thread.thread_field_deleted",
90+
"thread.service_level_agreement_status_transitioned",
8791
"customer.customer_created",
8892
"customer.customer_updated",
8993
"customer.customer_deleted",
@@ -1553,6 +1557,9 @@
15531557
],
15541558
"additionalProperties": false
15551559
},
1560+
"threadPriority": {
1561+
"type": "number"
1562+
},
15561563
"threadAssignee": {
15571564
"anyOf": [
15581565
{
@@ -1790,7 +1797,7 @@
17901797
"default": null
17911798
},
17921799
"priority": {
1793-
"type": "number"
1800+
"$ref": "#/definitions/threadPriority"
17941801
},
17951802
"externalId": {
17961803
"anyOf": [
@@ -2253,6 +2260,232 @@
22532260
],
22542261
"additionalProperties": false
22552262
},
2263+
"tier": {
2264+
"type": "object",
2265+
"properties": {
2266+
"id": {
2267+
"$ref": "#/definitions/id"
2268+
},
2269+
"name": {
2270+
"type": "string",
2271+
"minLength": 1,
2272+
"maxLength": 500
2273+
},
2274+
"externalId": {
2275+
"anyOf": [
2276+
{
2277+
"type": "string",
2278+
"minLength": 1,
2279+
"maxLength": 500
2280+
},
2281+
{
2282+
"type": "null"
2283+
}
2284+
]
2285+
},
2286+
"color": {
2287+
"type": "string",
2288+
"minLength": 1,
2289+
"maxLength": 500
2290+
},
2291+
"defaultThreadPriority": {
2292+
"$ref": "#/definitions/threadPriority",
2293+
"default": 2
2294+
},
2295+
"isDefault": {
2296+
"type": "boolean"
2297+
},
2298+
"createdAt": {
2299+
"$ref": "#/definitions/datetime"
2300+
},
2301+
"createdBy": {
2302+
"$ref": "#/definitions/internalActor"
2303+
},
2304+
"updatedAt": {
2305+
"$ref": "#/definitions/datetime"
2306+
},
2307+
"updatedBy": {
2308+
"$ref": "#/definitions/internalActor"
2309+
}
2310+
},
2311+
"required": [
2312+
"id",
2313+
"name",
2314+
"externalId",
2315+
"color",
2316+
"isDefault",
2317+
"createdAt",
2318+
"createdBy",
2319+
"updatedAt",
2320+
"updatedBy"
2321+
],
2322+
"additionalProperties": false
2323+
},
2324+
"serviceLevelAgreementStatusDetail": {
2325+
"anyOf": [
2326+
{
2327+
"type": "object",
2328+
"properties": {
2329+
"breachTime": {
2330+
"$ref": "#/definitions/threadMessageInfo/properties/timestamp"
2331+
},
2332+
"status": {
2333+
"type": "string",
2334+
"const": "PENDING"
2335+
}
2336+
},
2337+
"required": [
2338+
"breachTime",
2339+
"status"
2340+
],
2341+
"additionalProperties": false
2342+
},
2343+
{
2344+
"type": "object",
2345+
"properties": {
2346+
"achievedAt": {
2347+
"$ref": "#/definitions/threadMessageInfo/properties/timestamp"
2348+
},
2349+
"status": {
2350+
"type": "string",
2351+
"const": "ACHIEVED"
2352+
}
2353+
},
2354+
"required": [
2355+
"achievedAt",
2356+
"status"
2357+
],
2358+
"additionalProperties": false
2359+
},
2360+
{
2361+
"type": "object",
2362+
"properties": {
2363+
"breachTime": {
2364+
"$ref": "#/definitions/threadMessageInfo/properties/timestamp"
2365+
},
2366+
"status": {
2367+
"type": "string",
2368+
"const": "IMMINENT_BREACH"
2369+
}
2370+
},
2371+
"required": [
2372+
"breachTime",
2373+
"status"
2374+
],
2375+
"additionalProperties": false
2376+
},
2377+
{
2378+
"type": "object",
2379+
"properties": {
2380+
"breachedAt": {
2381+
"$ref": "#/definitions/threadMessageInfo/properties/timestamp"
2382+
},
2383+
"status": {
2384+
"type": "string",
2385+
"const": "BREACHING"
2386+
}
2387+
},
2388+
"required": [
2389+
"breachedAt",
2390+
"status"
2391+
],
2392+
"additionalProperties": false
2393+
},
2394+
{
2395+
"type": "object",
2396+
"properties": {
2397+
"breachedAt": {
2398+
"$ref": "#/definitions/threadMessageInfo/properties/timestamp"
2399+
},
2400+
"completedAt": {
2401+
"$ref": "#/definitions/threadMessageInfo/properties/timestamp"
2402+
},
2403+
"status": {
2404+
"type": "string",
2405+
"const": "BREACHED"
2406+
}
2407+
},
2408+
"required": [
2409+
"breachedAt",
2410+
"completedAt",
2411+
"status"
2412+
],
2413+
"additionalProperties": false
2414+
},
2415+
{
2416+
"type": "object",
2417+
"properties": {
2418+
"cancelledAt": {
2419+
"$ref": "#/definitions/threadMessageInfo/properties/timestamp"
2420+
},
2421+
"status": {
2422+
"type": "string",
2423+
"const": "CANCELLED"
2424+
}
2425+
},
2426+
"required": [
2427+
"cancelledAt",
2428+
"status"
2429+
],
2430+
"additionalProperties": false
2431+
}
2432+
]
2433+
},
2434+
"serviceLevelAgreement": {
2435+
"type": "object",
2436+
"properties": {
2437+
"id": {
2438+
"$ref": "#/definitions/id"
2439+
},
2440+
"type": {
2441+
"type": "string",
2442+
"enum": [
2443+
"FIRST_RESPONSE_TIME"
2444+
]
2445+
},
2446+
"tier": {
2447+
"$ref": "#/definitions/tier"
2448+
},
2449+
"firstResponseTimeMinutes": {
2450+
"type": "number"
2451+
},
2452+
"useBusinessHoursOnly": {
2453+
"type": "boolean"
2454+
},
2455+
"threadPriorityFilter": {
2456+
"type": "array",
2457+
"items": {
2458+
"$ref": "#/definitions/threadPriority"
2459+
},
2460+
"minItems": 1
2461+
},
2462+
"createdAt": {
2463+
"$ref": "#/definitions/datetime"
2464+
},
2465+
"createdBy": {
2466+
"$ref": "#/definitions/internalActor"
2467+
},
2468+
"updatedAt": {
2469+
"$ref": "#/definitions/datetime"
2470+
},
2471+
"updatedBy": {
2472+
"$ref": "#/definitions/internalActor"
2473+
}
2474+
},
2475+
"required": [
2476+
"id",
2477+
"type",
2478+
"tier",
2479+
"firstResponseTimeMinutes",
2480+
"useBusinessHoursOnly",
2481+
"threadPriorityFilter",
2482+
"createdAt",
2483+
"createdBy",
2484+
"updatedAt",
2485+
"updatedBy"
2486+
],
2487+
"additionalProperties": false
2488+
},
22562489
"customerChangedPayload": {
22572490
"type": "object",
22582491
"properties": {
@@ -2812,6 +3045,35 @@
28123045
],
28133046
"additionalProperties": false
28143047
},
3048+
"threadServiceLevelAgreementStatusTransitionedPayload": {
3049+
"type": "object",
3050+
"properties": {
3051+
"eventType": {
3052+
"type": "string",
3053+
"const": "thread.service_level_agreement_status_transitioned"
3054+
},
3055+
"thread": {
3056+
"$ref": "#/definitions/thread"
3057+
},
3058+
"serviceLevelAgreement": {
3059+
"$ref": "#/definitions/serviceLevelAgreement"
3060+
},
3061+
"previousServiceLevelAgreementStatusDetail": {
3062+
"$ref": "#/definitions/serviceLevelAgreementStatusDetail"
3063+
},
3064+
"serviceLevelAgreementStatusDetail": {
3065+
"$ref": "#/definitions/serviceLevelAgreementStatusDetail"
3066+
}
3067+
},
3068+
"required": [
3069+
"eventType",
3070+
"thread",
3071+
"serviceLevelAgreement",
3072+
"previousServiceLevelAgreementStatusDetail",
3073+
"serviceLevelAgreementStatusDetail"
3074+
],
3075+
"additionalProperties": false
3076+
},
28153077
"customerCreatedPublicEventPayload": {
28163078
"type": "object",
28173079
"properties": {

0 commit comments

Comments
 (0)