{"items":[{"type":"link","label":"Webhook Sender API","link":"/api-reference/legacy/webhook/tmp/generated/openapi","routeSlug":"/api-reference/legacy/webhook/tmp/generated/openapi","content":{"contentType":"overview","meta":{"name":"Webhook Sender API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/api-reference/@legacy/webhook/tmp/generated/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/api-reference/@legacy/webhook/tmp/generated/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Webhook Sender API (0.0.1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"API for managing webhooks"}],"sectionId":"/api-reference/legacy/webhook/tmp/generated/openapi"}],"sectionId":"/api-reference/legacy/webhook/tmp/generated/openapi"}]}]}},{"type":"group","label":"webhooks","link":"/api-reference/legacy/webhook/tmp/generated/openapi/webhooks","routeSlug":"/api-reference/legacy/webhook/tmp/generated/openapi/webhooks","items":[{"label":"Create a new subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/webhook/tmp/generated/openapi/webhooks/createsubscription","routeSlug":"/api-reference/legacy/webhook/tmp/generated/openapi/webhooks/createsubscription","metadata":{"seo":{"title":"Create a new subscription","description":"Create a new webhook subscription for a specific profile."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSubscription","name":"Create a new subscription","isWebhook":false,"pointer":"/paths/~1v4~1profiles~1{profileId}~1subscriptions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a new webhook subscription for a specific profile."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_1226","description":"The profile Id associated to this subscription","required":true,"example":12345}],"pointer":"/paths/~1v4~1profiles~1{profileId}~1subscriptions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriptionDTORequest"}},"schemaId":"components/schemas/SubscriptionDTORequest","pointer":"/paths/~1v4~1profiles~1{profileId}~1subscriptions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/profiles/{profileId}/subscriptions","servers":[{"url":"/"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":12345,"schemaId":"schema_1226"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SubscriptionDTORequest"}},"responseCodes":["200","400","401","403","422","500"],"pointer":"/v4/profiles/{profileId}/subscriptions","href":"webhooks/createsubscription","openApiOperationId":"createSubscription","summary":"Create a new subscription"},"isWebhook":false,"hideReplay":false,"schemaId":"components/schemas/SubscriptionDTORequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SubscriptionDTORequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Subscription created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionDTO"}},"schemaId":"components/schemas/SubscriptionDTO"},{"code":"400","description":"Validation or business rule failure","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_1227"}},"schemaId":"schema_1227"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/AccessError"}},"schemaId":"components/schemas/AccessError"},{"code":"403","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/AccessError"}},"schemaId":"components/schemas/AccessError"},{"code":"422","description":"Validation or business rule failure","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_1227"}},"schemaId":"schema_1227"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InternalServerError"}},"schemaId":"components/schemas/InternalServerError"}],"pointer":"/paths/~1v4~1profiles~1{profileId}~1subscriptions/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubscriptionDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionDTO"}}},{"code":"400","schemaId":"schema_1227","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_1227"}}},{"code":"401","schemaId":"components/schemas/AccessError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/AccessError"}}},{"code":"403","schemaId":"components/schemas/AccessError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/AccessError"}}},{"code":"422","schemaId":"schema_1227","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_1227"}}},{"code":"500","schemaId":"components/schemas/InternalServerError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InternalServerError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/createsubscription"}],"panels":[]}]},"httpPath":"/v4/profiles/{profileId}/subscriptions"},{"label":"List all subscriptions for a profile","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/webhook/tmp/generated/openapi/webhooks/listsubscriptions","routeSlug":"/api-reference/legacy/webhook/tmp/generated/openapi/webhooks/listsubscriptions","metadata":{"seo":{"title":"List all subscriptions for a profile","description":"Retrieve all webhook subscriptions associated with a specific profile."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSubscriptions","name":"List all subscriptions for a profile","isWebhook":false,"pointer":"/paths/~1v4~1profiles~1{profileId}~1subscriptions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all subscriptions for a profile","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve all webhook subscriptions associated with a specific profile."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_1226","description":"The profile Id associated to the subscriptions","required":true,"example":12345}],"pointer":"/paths/~1v4~1profiles~1{profileId}~1subscriptions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/profiles/{profileId}/subscriptions","servers":[{"url":"/"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":12345,"schemaId":"schema_1226"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","422","500"],"pointer":"/v4/profiles/{profileId}/subscriptions","href":"webhooks/listsubscriptions","openApiOperationId":"listSubscriptions","summary":"List all subscriptions for a profile"},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of subscriptions","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1228"}},"schemaId":"schema_1228"},{"code":"400","description":"Validation or business rule failure","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_1227"}},"schemaId":"schema_1227"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/AccessError"}},"schemaId":"components/schemas/AccessError"},{"code":"403","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/AccessError"}},"schemaId":"components/schemas/AccessError"},{"code":"422","description":"Validation or business rule failure","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_1227"}},"schemaId":"schema_1227"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InternalServerError"}},"schemaId":"components/schemas/InternalServerError"}],"pointer":"/paths/~1v4~1profiles~1{profileId}~1subscriptions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1228","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1228"}}},{"code":"400","schemaId":"schema_1227","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_1227"}}},{"code":"401","schemaId":"components/schemas/AccessError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/AccessError"}}},{"code":"403","schemaId":"components/schemas/AccessError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/AccessError"}}},{"code":"422","schemaId":"schema_1227","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_1227"}}},{"code":"500","schemaId":"components/schemas/InternalServerError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InternalServerError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/listsubscriptions"}],"panels":[]}]},"httpPath":"/v4/profiles/{profileId}/subscriptions"},{"label":"Fetch a specific subscription","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/webhook/tmp/generated/openapi/webhooks/fetchsubscription","routeSlug":"/api-reference/legacy/webhook/tmp/generated/openapi/webhooks/fetchsubscription","metadata":{"seo":{"title":"Fetch a specific subscription","description":"Retrieve details of a specific webhook subscription by its ID for a given profile."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"fetchSubscription","name":"Fetch a specific subscription","isWebhook":false,"pointer":"/paths/~1v4~1profiles~1{profileId}~1subscriptions~1{subscriptionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fetch a specific subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve details of a specific webhook subscription by its ID for a given profile."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_1226","description":"The profile Id associated to the subscription","required":true,"example":12345},{"name":"subscriptionId","in":"path","schemaId":"schema_1229","description":"The subscription Id","required":true,"example":"123e4567-e89b-12d3-a456-426614174000"}],"pointer":"/paths/~1v4~1profiles~1{profileId}~1subscriptions~1{subscriptionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/profiles/{profileId}/subscriptions/{subscriptionId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":12345,"schemaId":"schema_1226"},{"name":"subscriptionId","in":"path","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_1229"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","422","500"],"pointer":"/v4/profiles/{profileId}/subscriptions/{subscriptionId}","href":"webhooks/fetchsubscription","openApiOperationId":"fetchSubscription","summary":"Fetch a specific subscription"},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Subscription details","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionDTO"}},"schemaId":"components/schemas/SubscriptionDTO"},{"code":"400","description":"Validation or business rule failure","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_1227"}},"schemaId":"schema_1227"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/AccessError"}},"schemaId":"components/schemas/AccessError"},{"code":"403","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/AccessError"}},"schemaId":"components/schemas/AccessError"},{"code":"422","description":"Validation or business rule failure","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_1227"}},"schemaId":"schema_1227"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InternalServerError"}},"schemaId":"components/schemas/InternalServerError"}],"pointer":"/paths/~1v4~1profiles~1{profileId}~1subscriptions~1{subscriptionId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SubscriptionDTO","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SubscriptionDTO"}}},{"code":"400","schemaId":"schema_1227","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_1227"}}},{"code":"401","schemaId":"components/schemas/AccessError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/AccessError"}}},{"code":"403","schemaId":"components/schemas/AccessError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/AccessError"}}},{"code":"422","schemaId":"schema_1227","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_1227"}}},{"code":"500","schemaId":"components/schemas/InternalServerError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InternalServerError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/fetchsubscription"}],"panels":[]}]},"httpPath":"/v4/profiles/{profileId}/subscriptions/{subscriptionId}"},{"label":"Delete a subscription","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/webhook/tmp/generated/openapi/webhooks/deletesubscription","routeSlug":"/api-reference/legacy/webhook/tmp/generated/openapi/webhooks/deletesubscription","metadata":{"seo":{"title":"Delete a subscription","description":"Remove a specific webhook subscription by its ID for a given profile."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteSubscription","name":"Delete a subscription","isWebhook":false,"pointer":"/paths/~1v4~1profiles~1{profileId}~1subscriptions~1{subscriptionId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Remove a specific webhook subscription by its ID for a given profile."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_1226","description":"The profile Id associated to the subscription","required":true,"example":12345},{"name":"subscriptionId","in":"path","schemaId":"schema_1229","description":"The subscription Id","required":true,"example":"123e4567-e89b-12d3-a456-426614174000"}],"pointer":"/paths/~1v4~1profiles~1{profileId}~1subscriptions~1{subscriptionId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v4/profiles/{profileId}/subscriptions/{subscriptionId}","servers":[{"url":"/"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":12345,"schemaId":"schema_1226"},{"name":"subscriptionId","in":"path","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_1229"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","422","500"],"pointer":"/v4/profiles/{profileId}/subscriptions/{subscriptionId}","href":"webhooks/deletesubscription","openApiOperationId":"deleteSubscription","summary":"Delete a subscription"},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Subscription deleted successfully"},{"code":"400","description":"Validation or business rule failure","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_1227"}},"schemaId":"schema_1227"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/AccessError"}},"schemaId":"components/schemas/AccessError"},{"code":"403","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/AccessError"}},"schemaId":"components/schemas/AccessError"},{"code":"422","description":"Validation or business rule failure","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_1227"}},"schemaId":"schema_1227"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InternalServerError"}},"schemaId":"components/schemas/InternalServerError"}],"pointer":"/paths/~1v4~1profiles~1{profileId}~1subscriptions~1{subscriptionId}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"400","schemaId":"schema_1227","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_1227"}}},{"code":"401","schemaId":"components/schemas/AccessError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/AccessError"}}},{"code":"403","schemaId":"components/schemas/AccessError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/AccessError"}}},{"code":"422","schemaId":"schema_1227","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_1227"}}},{"code":"500","schemaId":"components/schemas/InternalServerError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InternalServerError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/deletesubscription"}],"panels":[]}]},"httpPath":"/v4/profiles/{profileId}/subscriptions/{subscriptionId}"},{"label":"Send test notifications for a subscription","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/legacy/webhook/tmp/generated/openapi/webhooks/sendtestnotification","routeSlug":"/api-reference/legacy/webhook/tmp/generated/openapi/webhooks/sendtestnotification","metadata":{"seo":{"title":"Send test notifications for a subscription","description":"Trigger test notifications for a specific webhook subscription to verify delivery."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"sendTestNotification","name":"Send test notifications for a subscription","isWebhook":false,"pointer":"/paths/~1v4~1profiles~1{profileId}~1subscriptions~1{subscriptionId}~1test-notifications/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send test notifications for a subscription","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Trigger test notifications for a specific webhook subscription to verify delivery."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"profileId","in":"path","schemaId":"schema_1226","description":"The profile Id associated to the subscription","required":true,"example":12345},{"name":"subscriptionId","in":"path","schemaId":"schema_1229","description":"The subscription ID","required":true,"example":"123e4567-e89b-12d3-a456-426614174000"}],"pointer":"/paths/~1v4~1profiles~1{profileId}~1subscriptions~1{subscriptionId}~1test-notifications/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/profiles/{profileId}/subscriptions/{subscriptionId}/test-notifications","servers":[{"url":"/"}],"parameters":{"path":[{"name":"profileId","in":"path","required":true,"example":12345,"schemaId":"schema_1226"},{"name":"subscriptionId","in":"path","required":true,"example":"123e4567-e89b-12d3-a456-426614174000","schemaId":"schema_1229"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","400","401","403","422","500"],"pointer":"/v4/profiles/{profileId}/subscriptions/{subscriptionId}/test-notifications","href":"webhooks/sendtestnotification","openApiOperationId":"sendTestNotification","summary":"Send test notifications for a subscription"},"isWebhook":false,"hideReplay":false,"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Test notifications sent","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1230"}},"schemaId":"schema_1230"},{"code":"400","description":"Validation or business rule failure","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_1227"}},"schemaId":"schema_1227"},{"code":"401","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/AccessError"}},"schemaId":"components/schemas/AccessError"},{"code":"403","description":"Unauthorized","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/AccessError"}},"schemaId":"components/schemas/AccessError"},{"code":"422","description":"Validation or business rule failure","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_1227"}},"schemaId":"schema_1227"},{"code":"500","description":"Internal Server Error","mediaType":"application/problem+json","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InternalServerError"}},"schemaId":"components/schemas/InternalServerError"}],"pointer":"/paths/~1v4~1profiles~1{profileId}~1subscriptions~1{subscriptionId}~1test-notifications/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1230","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1230"}}},{"code":"400","schemaId":"schema_1227","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_1227"}}},{"code":"401","schemaId":"components/schemas/AccessError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/AccessError"}}},{"code":"403","schemaId":"components/schemas/AccessError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/AccessError"}}},{"code":"422","schemaId":"schema_1227","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"schema_1227"}}},{"code":"500","schemaId":"components/schemas/InternalServerError","mediaTypes":["application/problem+json"],"mediaTypeContent":{"application/problem+json":{"schemaId":"components/schemas/InternalServerError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/sendtestnotification"}],"panels":[]}]},"httpPath":"/v4/profiles/{profileId}/subscriptions/{subscriptionId}/test-notifications"}],"content":{"contentType":"group","meta":{"name":"webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"webhooks","showPageActions":true},{"nodeType":"markdoc","content":"Operations related to webhooks"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v4/profiles/{profileId}/subscriptions","summary":"Create a new subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/createsubscription","deprecated":false},{"title":"/v4/profiles/{profileId}/subscriptions","summary":"List all subscriptions for a profile","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/listsubscriptions","deprecated":false},{"title":"/v4/profiles/{profileId}/subscriptions/{subscriptionId}","summary":"Fetch a specific subscription","prefix":{"name":"get","color":"get"},"badges":[],"link":"/webhooks/fetchsubscription","deprecated":false},{"title":"/v4/profiles/{profileId}/subscriptions/{subscriptionId}","summary":"Delete a subscription","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/webhooks/deletesubscription","deprecated":false},{"title":"/v4/profiles/{profileId}/subscriptions/{subscriptionId}/test-notifications","summary":"Send test notifications for a subscription","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/sendtestnotification","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/SubscriptionDTORequest":{"id":"components/schemas/SubscriptionDTORequest","kind":"json-schema","title":"SubscriptionDTORequest","data":{"type":"object","properties":{"name":{"type":"string","description":"A human-readable name for the subscription.","examples":["Order Confirmation Webhook"]},"delivery":{"$ref":"#/components/schemas/Delivery","description":"Details about how the event notification should be delivered (e.g., endpoint URL, version, mTLS)."},"trigger_on":{"type":"string","description":"The specific event or condition that triggers the subscription.","enum":["transfers#state-change","transfers#active-cases","transfers#transfer-suspension","balances#credit","balances#account-state-change","profiles#verification-state-change","batch-payment-initiations#state-change","swift-in#credit","transfers#payout-failure","transfers#refund","cards#transaction-state-change","account-details-payment#state-change","profiles#cdd-check-state-change","balances#update","cards#card-status-change","cards#card-order-status-change","partner-support#case-changed","bulk-settlement#payment-received","transaction-disputes#update","kyc-reviews#state-change","users#state-change","cards#3ds-challenge","cards#card-production-status-change","profiles#overdraft-limit-threshold","payment-instruments#status-change","payment-instruments-payins#status-change","account-details-order#order-state-change","acquiring-payments#payment-attempt-authorised","acquiring-payments#payment-attempt-failed","acquiring-payments#payment-attempt-captured","cards#manual-provisioning-verification"],"examples":["transfers#state-change"]},"request_headers":{"type":"array","description":"A list of custom headers to be included in the delivery request.","items":{"$ref":"#/components/schemas/RequestHeaderDTO"}},"enabled":{"type":"boolean","description":"Flag indicating whether the subscription is currently active.","default":true,"examples":[true]}},"required":["name","delivery","trigger_on","enabled"]}},"components/schemas/SubscriptionDTO":{"id":"components/schemas/SubscriptionDTO","kind":"json-schema","title":"SubscriptionDTO","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the subscription.","examples":["123e4567-e89b-12d3-a456-426614174000"]},"name":{"type":"string","description":"A human-readable name for the subscription.","examples":["Order Confirmation Webhook"]},"delivery":{"$ref":"#/components/schemas/Delivery","description":"Details about how the event notification should be delivered (e.g., endpoint URL, version, mTLS)."},"trigger_on":{"type":"string","description":"The specific event or condition that triggers the subscription.","enum":["transfers#state-change","transfers#active-cases","transfers#transfer-suspension","balances#credit","balances#account-state-change","profiles#verification-state-change","batch-payment-initiations#state-change","swift-in#credit","transfers#payout-failure","transfers#refund","cards#transaction-state-change","account-details-payment#state-change","profiles#cdd-check-state-change","balances#update","cards#card-status-change","cards#card-order-status-change","partner-support#case-changed","bulk-settlement#payment-received","transaction-disputes#update","kyc-reviews#state-change","users#state-change","cards#3ds-challenge","cards#card-production-status-change","profiles#overdraft-limit-threshold","payment-instruments#status-change","payment-instruments-payins#status-change","account-details-order#order-state-change","acquiring-payments#payment-attempt-authorised","acquiring-payments#payment-attempt-failed","acquiring-payments#payment-attempt-captured","cards#manual-provisioning-verification"],"examples":["transfers#state-change"]},"created_by":{"$ref":"#/components/schemas/CreatedBy","description":"Information about the user or system that created the subscription."},"created_at":{"type":"string","format":"date-time","description":"Timestamp of when the subscription was created.","examples":["2024-01-15T10:00:00Z"]},"scope":{"$ref":"#/components/schemas/Scope","description":"Defines the scope or context for which the subscription is active."},"request_headers":{"type":"array","description":"A list of custom headers to be included in the delivery request.","items":{"$ref":"#/components/schemas/RequestHeaderDTO"}},"enabled":{"type":"boolean","description":"Flag indicating whether the subscription is currently active.","default":true,"examples":[true]}},"required":["id","name","delivery","trigger_on","created_by","created_at","scope","enabled"]}},"components/schemas/TestNotificationDTO":{"id":"components/schemas/TestNotificationDTO","kind":"json-schema","title":"TestNotificationDTO","data":{"type":"object","description":"Test notification details","properties":{"delivery_id":{"type":"string","description":"The unique identifier for the notification delivery","examples":["123e4567-e89b-12d3-a456-426614174000"]},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the test notification was created","examples":["2024-01-15T10:00:00Z"]}},"required":["delivery_id","created_at"]}},"components/schemas/Delivery":{"id":"components/schemas/Delivery","kind":"json-schema","title":"Delivery","data":{"type":"object","description":"Represents the delivery configuration for a webhook.\n","properties":{"version":{"type":"string","description":"The API version or schema version of the payload being delivered.\n","examples":["2.0.0"]},"url":{"type":"string","format":"url","description":"The endpoint URL where the payload will be delivered (e.g., a webhook URL).","examples":["https://example.com/webhook/receive"]},"mtls_enabled":{"type":"boolean","description":"A flag indicating whether Mutual TLS (mTLS) is required or enabled for this delivery endpoint.\n","default":false,"examples":[true]}},"required":["version","url"]}},"components/schemas/CreatedBy":{"id":"components/schemas/CreatedBy","kind":"json-schema","title":"CreatedBy","data":{"type":"object","properties":{"type":{"type":"string","enum":["user","application"],"description":"The type of creator (user or application)","examples":["application"]},"id":{"type":"string","description":"The identifier of the creator (userId for users, clientKey for applications)","examples":[1234]}},"required":["type","id"]}},"components/schemas/Scope":{"id":"components/schemas/Scope","kind":"json-schema","title":"Scope","data":{"type":"object","properties":{"domain":{"type":"string","enum":["application","profile"],"description":"The scope domain type","examples":["application"]},"id":{"type":"string","description":"The identifier for the scope (application ID or profile ID)","examples":["4ce7a515-6aa4-42e5-8bc2-e1138f64d481"]}},"required":["domain","id"]}},"components/schemas/RequestHeaderDTO":{"id":"components/schemas/RequestHeaderDTO","kind":"json-schema","title":"RequestHeaderDTO","data":{"type":"object","properties":{"header_name":{"type":"string","description":"The name of the HTTP header","examples":["X-Custom-Header"]},"header_value":{"type":"string","description":"The value of the HTTP header","examples":["CustomValue123"]}},"required":["header_name","header_value"]}},"components/schemas/ProblemDetail":{"id":"components/schemas/ProblemDetail","kind":"json-schema","title":"ProblemDetail","data":{"type":"object","properties":{"type":{"type":"string","format":"uri-reference","description":"A URI reference that identifies the problem type."},"title":{"type":"string","description":"A short, human-readable summary of the problem type."},"status":{"type":"integer","format":"int32","description":"The HTTP status code (e.g., 400).","examples":[400]},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem."},"instance":{"type":"string","format":"uri-reference","description":"A URI reference that identifies the specific occurrence of the problem.","examples":["/api/v1/users/1234"]}},"required":["type","status"]}},"components/schemas/DomainError":{"id":"components/schemas/DomainError","kind":"json-schema","title":"DomainError","data":{"allOf":[{"$ref":"#/components/schemas/ProblemDetail"},{"type":"object","properties":{"type":{"description":"Must be /errors/types/domain for this error type.","examples":["/errors/types/domain"]},"title":{"examples":["Domain Error"]},"status":{"examples":[422]},"detail":{"examples":["Error occurred due to some business logic"]},"instance":{"examples":["/api/v1/users/1234"]},"code":{"type":"string","examples":["exceeds_max_limit"]},"attributes":{"type":"object","description":"A generic map of key-value pairs providing additional context \nfor the domain error.\n","additionalProperties":true,"examples":[{"min_length":3,"max_length":50}]}},"required":["type","status","code","attributes"]}]}},"components/schemas/ValidationError":{"id":"components/schemas/ValidationError","kind":"json-schema","title":"ValidationError","data":{"allOf":[{"$ref":"#/components/schemas/ProblemDetail"},{"type":"object","properties":{"type":{"description":"Must be /errors/types/validation for this error type.","examples":["/errors/types/validation"]},"title":{"examples":["Validation Error"]},"status":{"examples":[400]},"detail":{"examples":["Error occurred due to some validation logic"]},"instance":{"examples":["/api/v1/users/1234"]},"errors":{"type":"array","description":"A list of specific validation failures.","items":{"$ref":"#/components/schemas/ValidationFailure"}}},"required":["type","status","errors"]}]}},"components/schemas/ValidationFailure":{"id":"components/schemas/ValidationFailure","kind":"json-schema","title":"ValidationFailure","data":{"type":"object","properties":{"detail":{"type":"string","description":"A detailed description of the validation failure.","examples":["Name is required"]},"code":{"type":"string","description":"A specific code for the validation failure type.","examples":["missing_value"]},"ref":{"type":"string","description":"A reference to the field that failed validation.","examples":["name"]},"attributes":{"type":"object","description":"A generic map of key-value pairs providing additional context \nfor the domain error.\n","additionalProperties":true,"examples":[{"min_length":3,"max_length":50}]}},"required":["code","ref"]}},"components/schemas/InternalServerError":{"id":"components/schemas/InternalServerError","kind":"json-schema","title":"InternalServerError","data":{"allOf":[{"$ref":"#/components/schemas/ProblemDetail"},{"type":"object","properties":{"type":{"examples":["/errors/types/server"]},"title":{"examples":["Internal Server Error"]},"status":{"examples":[500]},"detail":{"examples":["An unexpected error occurred during user registration"]},"instance":{"examples":["/api/v1/users/1234"]}},"required":["type","status"]}]}},"components/schemas/AccessError":{"id":"components/schemas/AccessError","kind":"json-schema","title":"AccessError","data":{"allOf":[{"$ref":"#/components/schemas/ProblemDetail"},{"type":"object","properties":{"type":{"examples":["/errors/types/access"]},"title":{"examples":["Invalid token"]},"status":{"examples":[401]},"detail":{"examples":["Invalid token"]},"instance":{"examples":["/api/v1/users/1234"]},"code":{"type":"string","description":"A specific application-level code for the access problem.","examples":["unauthorized"]}},"required":["type","status","code"]}]}},"schema_1226":{"kind":"json-schema","data":{"type":"integer","format":"int64"},"id":"schema_1226"},"schema_1227":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/ValidationError"},{"$ref":"#/components/schemas/DomainError"}],"discriminator":{"propertyName":"type","mapping":{"/errors/types/validation":"#/components/schemas/ValidationError","/errors/types/domain":"#/components/schemas/DomainError"}}},"id":"schema_1227"},"schema_1228":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionDTO"}},"id":"schema_1228"},"schema_1229":{"kind":"json-schema","data":{"type":"string"},"id":"schema_1229"},"schema_1230":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/TestNotificationDTO"}},"id":"schema_1230"}},"exampleStore":{},"securitySchemeStore":{"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer","bearerFormat":"JWT"}},"specType":"openapi"},"options":{"hideDownloadButtons":false,"hideReplay":true,"hideSchemaTitles":true,"jsonSamplesExpandLevel":3,"schemasExpansionLevel":1,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/api-reference/@legacy/webhook/tmp/generated/openapi.json?download"},{"url":"/_bundle/api-reference/@legacy/webhook/tmp/generated/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Webhook Sender API","description":"API for managing webhooks"}},"baseSlug":"/api-reference/legacy/webhook/tmp/generated/openapi","routesMapping":{}}