@@ -1633,6 +1633,7 @@ tags:
16331633- name: Variables
16341634- name: Versions / History
16351635- name: Webhooks
1636+ - name: Webhook Deliveries
16361637paths:
16371638 /icu/skeleton:
16381639 post:
@@ -25463,6 +25464,296 @@ paths:
2546325464 --access_token <token>
2546425465 x-contentType: application/json
2546525466 x-accepts: application/json
25467+ /projects/{project_id}/webhooks/{webhook_id}/deliveries:
25468+ get:
25469+ description: List all webhook deliveries for the given webhook_id.
25470+ operationId: webhook_deliveries/list
25471+ parameters:
25472+ - description: Two-Factor-Authentication token (optional)
25473+ explode: false
25474+ in: header
25475+ name: X-PhraseApp-OTP
25476+ required: false
25477+ schema:
25478+ type: string
25479+ style: simple
25480+ - description: Project ID
25481+ explode: false
25482+ in: path
25483+ name: project_id
25484+ required: true
25485+ schema:
25486+ type: string
25487+ style: simple
25488+ - description: Webhook ID
25489+ explode: false
25490+ in: path
25491+ name: webhook_id
25492+ required: true
25493+ schema:
25494+ type: string
25495+ style: simple
25496+ - description: List of Response Status Codes
25497+ explode: true
25498+ in: query
25499+ name: response_status_codes
25500+ required: false
25501+ schema:
25502+ type: string
25503+ style: form
25504+ responses:
25505+ "200":
25506+ content:
25507+ application/json:
25508+ schema:
25509+ items:
25510+ $ref: '#/components/schemas/webhook_delivery'
25511+ type: array
25512+ description: OK
25513+ headers:
25514+ X-Rate-Limit-Limit:
25515+ $ref: '#/components/headers/X-Rate-Limit-Limit'
25516+ X-Rate-Limit-Remaining:
25517+ $ref: '#/components/headers/X-Rate-Limit-Remaining'
25518+ X-Rate-Limit-Reset:
25519+ $ref: '#/components/headers/X-Rate-Limit-Reset'
25520+ Link:
25521+ $ref: '#/components/headers/Link'
25522+ "400":
25523+ description: Bad request
25524+ headers:
25525+ X-Rate-Limit-Limit:
25526+ $ref: '#/components/headers/X-Rate-Limit-Limit'
25527+ X-Rate-Limit-Remaining:
25528+ $ref: '#/components/headers/X-Rate-Limit-Remaining'
25529+ X-Rate-Limit-Reset:
25530+ $ref: '#/components/headers/X-Rate-Limit-Reset'
25531+ "404":
25532+ description: Not Found
25533+ headers:
25534+ X-Rate-Limit-Limit:
25535+ $ref: '#/components/headers/X-Rate-Limit-Limit'
25536+ X-Rate-Limit-Remaining:
25537+ $ref: '#/components/headers/X-Rate-Limit-Remaining'
25538+ X-Rate-Limit-Reset:
25539+ $ref: '#/components/headers/X-Rate-Limit-Reset'
25540+ "429":
25541+ description: Rate Limiting
25542+ headers:
25543+ X-Rate-Limit-Limit:
25544+ $ref: '#/components/headers/X-Rate-Limit-Limit'
25545+ X-Rate-Limit-Remaining:
25546+ $ref: '#/components/headers/X-Rate-Limit-Remaining'
25547+ X-Rate-Limit-Reset:
25548+ $ref: '#/components/headers/X-Rate-Limit-Reset'
25549+ summary: List webhook deliveries
25550+ tags:
25551+ - Webhook Deliveries
25552+ x-code-samples:
25553+ - lang: Curl
25554+ source: |-
25555+ curl "https://api.phrase.com/v2/projects/:project_id/webhooks/:webhook_id/deliveries?response_status_codes=401%2C404" \
25556+ -u USERNAME_OR_ACCESS_TOKEN
25557+ - lang: CLI v2
25558+ source: |-
25559+ phrase webhooks list \
25560+ --project_id <project_id> \
25561+ --webhook_id <webhook_id> \
25562+ --access_token <token>
25563+ x-accepts: application/json
25564+ /projects/{project_id}/webhooks/{webhook_id}/deliveries/{id}:
25565+ get:
25566+ description: Get all information about a single webhook delivery for the given
25567+ ID.
25568+ operationId: webhook_deliveries/show
25569+ parameters:
25570+ - description: Two-Factor-Authentication token (optional)
25571+ explode: false
25572+ in: header
25573+ name: X-PhraseApp-OTP
25574+ required: false
25575+ schema:
25576+ type: string
25577+ style: simple
25578+ - description: Project ID
25579+ explode: false
25580+ in: path
25581+ name: project_id
25582+ required: true
25583+ schema:
25584+ type: string
25585+ style: simple
25586+ - description: Webhook ID
25587+ explode: false
25588+ in: path
25589+ name: webhook_id
25590+ required: true
25591+ schema:
25592+ type: string
25593+ style: simple
25594+ - description: ID
25595+ explode: false
25596+ in: path
25597+ name: id
25598+ required: true
25599+ schema:
25600+ type: string
25601+ style: simple
25602+ responses:
25603+ "200":
25604+ content:
25605+ application/json:
25606+ schema:
25607+ $ref: '#/components/schemas/webhook_delivery'
25608+ description: OK
25609+ headers:
25610+ X-Rate-Limit-Limit:
25611+ $ref: '#/components/headers/X-Rate-Limit-Limit'
25612+ X-Rate-Limit-Remaining:
25613+ $ref: '#/components/headers/X-Rate-Limit-Remaining'
25614+ X-Rate-Limit-Reset:
25615+ $ref: '#/components/headers/X-Rate-Limit-Reset'
25616+ Link:
25617+ $ref: '#/components/headers/Link'
25618+ "400":
25619+ description: Bad request
25620+ headers:
25621+ X-Rate-Limit-Limit:
25622+ $ref: '#/components/headers/X-Rate-Limit-Limit'
25623+ X-Rate-Limit-Remaining:
25624+ $ref: '#/components/headers/X-Rate-Limit-Remaining'
25625+ X-Rate-Limit-Reset:
25626+ $ref: '#/components/headers/X-Rate-Limit-Reset'
25627+ "404":
25628+ description: Not Found
25629+ headers:
25630+ X-Rate-Limit-Limit:
25631+ $ref: '#/components/headers/X-Rate-Limit-Limit'
25632+ X-Rate-Limit-Remaining:
25633+ $ref: '#/components/headers/X-Rate-Limit-Remaining'
25634+ X-Rate-Limit-Reset:
25635+ $ref: '#/components/headers/X-Rate-Limit-Reset'
25636+ "429":
25637+ description: Rate Limiting
25638+ headers:
25639+ X-Rate-Limit-Limit:
25640+ $ref: '#/components/headers/X-Rate-Limit-Limit'
25641+ X-Rate-Limit-Remaining:
25642+ $ref: '#/components/headers/X-Rate-Limit-Remaining'
25643+ X-Rate-Limit-Reset:
25644+ $ref: '#/components/headers/X-Rate-Limit-Reset'
25645+ summary: Get a single webhook delivery
25646+ tags:
25647+ - Webhook Deliveries
25648+ x-code-samples:
25649+ - lang: Curl
25650+ source: |-
25651+ curl "https://api.phrase.com/v2/projects/:project_id/webhooks/:webhook_id/deliveries/:id" \
25652+ -u USERNAME_OR_ACCESS_TOKEN
25653+ - lang: CLI v2
25654+ source: |-
25655+ phrase webhook deliveries show \
25656+ --project_id <project_id> \
25657+ --webhook_id <webhook_id> \
25658+ --id <delivery_id> \
25659+ --access_token <token>
25660+ x-accepts: application/json
25661+ /projects/{project_id}/webhooks/{webhook_id}/deliveries/{id}/redeliver:
25662+ post:
25663+ description: Trigger an individual webhook delivery to be redelivered.
25664+ operationId: webhook_deliveries/redeliver
25665+ parameters:
25666+ - description: Two-Factor-Authentication token (optional)
25667+ explode: false
25668+ in: header
25669+ name: X-PhraseApp-OTP
25670+ required: false
25671+ schema:
25672+ type: string
25673+ style: simple
25674+ - description: Project ID
25675+ explode: false
25676+ in: path
25677+ name: project_id
25678+ required: true
25679+ schema:
25680+ type: string
25681+ style: simple
25682+ - description: Webhook ID
25683+ explode: false
25684+ in: path
25685+ name: webhook_id
25686+ required: true
25687+ schema:
25688+ type: string
25689+ style: simple
25690+ - description: ID
25691+ explode: false
25692+ in: path
25693+ name: id
25694+ required: true
25695+ schema:
25696+ type: string
25697+ style: simple
25698+ responses:
25699+ "200":
25700+ content:
25701+ application/json:
25702+ schema:
25703+ $ref: '#/components/schemas/webhook_delivery'
25704+ description: OK
25705+ headers:
25706+ X-Rate-Limit-Limit:
25707+ $ref: '#/components/headers/X-Rate-Limit-Limit'
25708+ X-Rate-Limit-Remaining:
25709+ $ref: '#/components/headers/X-Rate-Limit-Remaining'
25710+ X-Rate-Limit-Reset:
25711+ $ref: '#/components/headers/X-Rate-Limit-Reset'
25712+ Link:
25713+ $ref: '#/components/headers/Link'
25714+ "400":
25715+ description: Bad request
25716+ headers:
25717+ X-Rate-Limit-Limit:
25718+ $ref: '#/components/headers/X-Rate-Limit-Limit'
25719+ X-Rate-Limit-Remaining:
25720+ $ref: '#/components/headers/X-Rate-Limit-Remaining'
25721+ X-Rate-Limit-Reset:
25722+ $ref: '#/components/headers/X-Rate-Limit-Reset'
25723+ "404":
25724+ description: Not Found
25725+ headers:
25726+ X-Rate-Limit-Limit:
25727+ $ref: '#/components/headers/X-Rate-Limit-Limit'
25728+ X-Rate-Limit-Remaining:
25729+ $ref: '#/components/headers/X-Rate-Limit-Remaining'
25730+ X-Rate-Limit-Reset:
25731+ $ref: '#/components/headers/X-Rate-Limit-Reset'
25732+ "429":
25733+ description: Rate Limiting
25734+ headers:
25735+ X-Rate-Limit-Limit:
25736+ $ref: '#/components/headers/X-Rate-Limit-Limit'
25737+ X-Rate-Limit-Remaining:
25738+ $ref: '#/components/headers/X-Rate-Limit-Remaining'
25739+ X-Rate-Limit-Reset:
25740+ $ref: '#/components/headers/X-Rate-Limit-Reset'
25741+ summary: Redeliver a single webhook delivery
25742+ tags:
25743+ - Webhook Deliveries
25744+ x-code-samples:
25745+ - lang: Curl
25746+ source: |-
25747+ curl "https://api.phrase.com/v2/projects/:project_id/webhooks/:webhook_id/deliveries/:id/redeliver" \
25748+ -u USERNAME_OR_ACCESS_TOKEN
25749+ - lang: CLI v2
25750+ source: |-
25751+ phrase webhook deliveries show \
25752+ --project_id <project_id> \
25753+ --webhook_id <webhook_id> \
25754+ --id <delivery_id> \
25755+ --access_token <token>
25756+ x-accepts: application/json
2546625757components:
2546725758 headers:
2546825759 Link:
@@ -25693,6 +25984,24 @@ components:
2569325984 schema:
2569425985 type: integer
2569525986 style: form
25987+ webhook_id:
25988+ description: Webhook ID
25989+ explode: false
25990+ in: path
25991+ name: webhook_id
25992+ required: true
25993+ schema:
25994+ type: string
25995+ style: simple
25996+ response_status_codes:
25997+ description: List of Response Status Codes
25998+ explode: true
25999+ in: query
26000+ name: response_status_codes
26001+ required: false
26002+ schema:
26003+ type: string
26004+ style: form
2569626005 requestBodies:
2569726006 member_update_settings_parameters:
2569826007 content:
@@ -27540,6 +27849,35 @@ components:
2754027849 type: string
2754127850 title: webhook
2754227851 type: object
27852+ webhook_delivery:
27853+ example:
27854+ duration_ms: 6
27855+ updated_at: 2000-01-23T04:56:07.000+00:00
27856+ webhook_id: webhook_id
27857+ created_at: 2000-01-23T04:56:07.000+00:00
27858+ id: id
27859+ delivered_at: 2000-01-23T04:56:07.000+00:00
27860+ response_status_code: 0
27861+ properties:
27862+ id:
27863+ type: string
27864+ webhook_id:
27865+ type: string
27866+ response_status_code:
27867+ type: integer
27868+ delivered_at:
27869+ format: date-time
27870+ type: string
27871+ duration_ms:
27872+ type: integer
27873+ created_at:
27874+ format: date-time
27875+ type: string
27876+ updated_at:
27877+ format: date-time
27878+ type: string
27879+ title: webhook delivery
27880+ type: object
2754327881 space:
2754427882 example:
2754527883 id: 2e7574e8f2372906a03110c2a7cfe671
0 commit comments