--- updatedAt: 2026-07-29T07:06:26.000Z agentTools: siteIndex: https://developer.bitmovin.com/llms.txt projectIndex: https://developer.bitmovin.com/encoding/llms.txt --- # Create 'Encoding Finished' Webhook Add a new webhook notification that triggers if an encoding finishes successfully. A maximum number of 5 webhooks is allowed # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "Live Encoding API", "description": "Bitmovins API Reference Description", "version": "3.0", "termsOfService": "https://bitmovin.com", "contact": { "name": "Bitmovin Inc", "url": "https://bitmovin.com", "email": "support@bitmovin.com" } }, "servers": [ { "url": "https://api.bitmovin.com/v1", "description": "Bitmovin Server", "variables": {} } ], "security": [ { "ApiKeyAuth": [] }, { "ApiKeyAuth": [], "TenantOrgId": [] } ], "paths": { "/notifications/webhooks/encoding/encodings/finished": { "post": { "tags": [ "Webhooks" ], "summary": "Create 'Encoding Finished' Webhook", "description": "Add a new webhook notification that triggers if an encoding finishes successfully. A maximum number of 5 webhooks is allowed", "operationId": "LivePostNotificationsWebhooksEncodingEncodingsFinished", "x-bitmovin": { "product": "shared" }, "requestBody": { "description": "The 'Encoding Finished' Webhook to be added.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } } }, "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/ResponseEnvelope" }, { "properties": { "data": { "properties": { "result": { "allOf": [ { "$ref": "#/components/schemas/Webhook" }, { "description": "Webhook Details" } ] } } } } } ] } } } }, "default": { "description": "Error response.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseError" } } } } } } } }, "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "description": "Your Bitmovin API key", "name": "X-Api-Key", "in": "header" }, "TenantOrgId": { "type": "apiKey", "description": "Your Bitmovin account organization", "name": "X-Tenant-Org-Id", "in": "header" } }, "schemas": { "BitmovinResource": { "title": "BitmovinResource", "allOf": [ { "$ref": "#/components/schemas/BitmovinResponse" }, { "properties": { "name": { "type": "string", "description": "Name of the resource. Can be freely chosen by the user.", "example": "Name of the resource" }, "description": { "type": "string", "description": "Description of the resource. Can be freely chosen by the user.", "example": "Description of the resource" }, "createdAt": { "type": "string", "format": "date-time", "readOnly": true, "description": "Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ", "example": "2016-06-25T20:09:23.69Z" }, "modifiedAt": { "type": "string", "format": "date-time", "readOnly": true, "description": "Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ", "example": "2016-06-25T20:09:23.69Z" }, "customData": { "type": "string", "writeOnly": true, "description": "User-specific meta data. This can hold anything.", "additionalProperties": { "type": "object" } } } } ] }, "BitmovinResponse": { "title": "BitmovinResponse", "required": [ "id" ], "properties": { "id": { "type": "string", "readOnly": true, "description": "Id of the resource", "example": "cb90b80c-8867-4e3b-8479-174aa2843f62" } } }, "Link": { "title": "Link", "required": [ "href" ], "properties": { "href": { "type": "string", "description": "webpage target URL", "example": "https://bitmovin.com/encoding-documentation/bitmovin-api/#/reference/encoding/manifests/add-period" }, "title": { "type": "string", "description": "Short description of the linked page", "example": "how to add a period to a manifest" } } }, "Message": { "title": "Message", "required": [ "type", "text" ], "allOf": [ { "$ref": "#/components/schemas/BitmovinResponse" }, { "properties": { "type": { "description": "Message type giving a hint on the importance of the message (log level)", "allOf": [ { "$ref": "#/components/schemas/MessageType" } ] }, "text": { "type": "string", "description": "Message text", "example": "field must not be empty" }, "field": { "type": "string", "description": "Name of the field to which the message is referring to", "example": "manifestId" }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/Link" }, "description": "collection of links to webpages containing further information on the topic" }, "more": { "type": "object", "description": "Service-specific information" }, "date": { "type": "string", "format": "date-time", "description": "Timestamp when the message occurred", "example": "2016-06-25T20:09:23.69Z" } } } ] }, "MessageType": { "title": "MessageType", "type": "string", "enum": [ "ERROR", "WARNING", "INFO", "DEBUG", "TRACE" ] }, "ResponseEnvelope": { "title": "ResponseEnvelope", "required": [ "requestId", "status", "data" ], "properties": { "requestId": { "type": "string", "readOnly": true, "description": "Unique correlation id", "example": "6d84e126-d10c-4e52-bbfb-bd4c92bc8333" }, "status": { "description": "Response status information", "readOnly": true, "example": "SUCCESS", "allOf": [ { "$ref": "#/components/schemas/ResponseStatus" } ] }, "data": { "description": "Response information", "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/ResultWrapper" } ] }, "more": { "type": "object", "description": "Additional endpoint specific information" } } }, "ResponseError": { "title": "ResponseError", "required": [ "requestId", "status", "data" ], "properties": { "requestId": { "type": "string", "readOnly": true, "description": "Unique correlation id", "example": "6d84e126-d10c-4e52-bbfb-bd4c92bc8333" }, "status": { "description": "Response status information", "readOnly": true, "example": "ERROR", "allOf": [ { "$ref": "#/components/schemas/ResponseStatus" } ] }, "data": { "description": "Response information", "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/ResponseErrorData" } ] } } }, "ResponseErrorData": { "title": "ResponseErrorData", "required": [ "code", "message", "developerMessage" ], "properties": { "code": { "type": "integer", "format": "int32", "readOnly": true, "description": "Contains an error code as defined in https://bitmovin.com/encoding-documentation/bitmovin-api/#/introduction/api-error-codes\n", "example": 1005 }, "message": { "type": "string", "readOnly": true, "description": "General error message" }, "developerMessage": { "type": "string", "readOnly": true, "description": "More detailed message meant for developers" }, "links": { "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/Link" }, "description": "collection of links to webpages containing further information on the topic" }, "details": { "type": "array", "readOnly": true, "items": { "$ref": "#/components/schemas/Message" }, "description": "collection of messages containing more detailed information on the cause of the error" } } }, "ResponseStatus": { "title": "ResponseStatus", "type": "string", "enum": [ "SUCCESS", "ERROR" ] }, "ResultWrapper": { "title": "ResultWrapper", "properties": { "result": { "type": "object", "readOnly": true } } }, "SignatureType": { "title": "SignatureType", "type": "string", "enum": [ "HMAC" ] }, "Webhook": { "title": "Webhook", "required": [ "url" ], "allOf": [ { "$ref": "#/components/schemas/BitmovinResource" }, { "properties": { "url": { "type": "string", "description": "Webhook URL", "example": "https://yourendpoint.yourcorp.com/webhooks/encoding/finished" }, "method": { "description": "HTTP method used for the webhook", "allOf": [ { "$ref": "#/components/schemas/WebhookHttpMethod" } ] }, "insecureSsl": { "type": "boolean", "description": "Skip verification of the SSL certificate", "example": false }, "signature": { "description": "Signature used for the webhook", "allOf": [ { "$ref": "#/components/schemas/WebhookSignature" } ] }, "schema": { "readOnly": true, "description": "JSON schema of the webhook payload", "example": "{\n \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n \"title\": \"Encoding Webhook Event\",\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"eventId\": {\n \"type\": \"string\"\n },\n \"createdAt\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"modifiedAt\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"orgId\": {\n \"type\": \"string\"\n },\n \"userId\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"notificationId\": {\n \"type\": \"string\"\n },\n \"resourceId\": {\n \"type\": \"string\"\n },\n \"resourceType\": {\n \"type\": \"string\",\n \"enum\": [\n \"NONE\",\n \"ENCODING\"\n ]\n },\n \"type\": {\n \"type\": \"string\",\n \"enum\": [\n \"EMAIL\",\n \"WEBHOOK\"\n ]\n },\n \"eventType\": {\n \"type\": \"string\",\n \"enum\": [\n \"MANIFEST_ERROR\",\n \"USAGE_REPORT\",\n \"ENCODING_ERROR\",\n \"PRODUCT_USAGE_QUOTA_ALERT\",\n \"LIVE_INPUT_STREAM_CHANGED\",\n \"LIVE_ENCODING_HEARTBEAT\",\n \"MANIFEST_FINISHED\",\n \"ENCODING_TRANSFER_ERROR\",\n \"PRODUCT_USAGE_PREDICTION_ALERT\",\n \"ENCODING_FINISHED\",\n \"LIVE_MANIFEST_READY\"\n ]\n },\n \"category\": {\n \"type\": \"string\",\n \"enum\": [\n \"USAGE_REPORT\",\n \"PRODUCT_USAGE_PREDICTION\",\n \"ENCODING\",\n \"PRODUCT_USAGE_QUOTA\",\n \"MANIFEST\"\n ]\n },\n \"state\": {\n \"type\": \"string\",\n \"enum\": [\n \"FIRED\",\n \"RESOLVED\"\n ]\n },\n \"triggeredAt\": {\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"triggeredForResourceId\": {\n \"type\": \"string\"\n },\n \"internal\": {\n \"type\": \"boolean\"\n },\n \"purpose\": {\n \"type\": \"string\",\n \"enum\": []\n },\n \"customData\": {},\n \"encoding\": {\n \"$ref\": \"#/definitions/EncodingDTO\"\n },\n \"webhookId\": {\n \"type\": \"string\"\n }\n },\n \"definitions\": {\n \"EncodingDTO\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"id\": {\n \"type\": \"string\"\n },\n \"type\": {\n \"type\": \"string\"\n },\n \"name\": {\n \"type\": \"string\"\n },\n \"description\": {\n \"type\": \"string\"\n },\n \"encoderVersion\": {\n \"type\": \"string\"\n },\n \"cloudRegion\": {\n \"type\": \"string\"\n }\n }\n }\n }\n}\n" } } } ] }, "WebhookHttpMethod": { "title": "WebhookHttpMethod", "type": "string", "enum": [ "POST", "PUT" ] }, "WebhookSignature": { "title": "WebhookSignature", "required": [ "type", "key" ], "properties": { "type": { "description": "The signature type used for the webhook.\n\nSelects one of the supported signatures. The signature is attached to the list of headers with the key `Bitmovin-Signature`.\nIn case of the `HMAC` type the SHA512 hashing algorithm is used to generate an authentication code from the webhook body.\n", "example": "HMAC", "allOf": [ { "$ref": "#/components/schemas/SignatureType" } ] }, "key": { "type": "string", "description": "The key of the signature", "writeOnly": true, "example": "secretKey" } } } } }, "tags": [ { "name": "Webhooks" } ] } ```