Webhook Endpoint
Webhook endpoint management.
GET/api/webhook_endpoints
Retrieves the collection of WebhookEndpoint resources.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| page | query | integer | no | The collection page number |
Code samples
curl -X GET 'https://sandbox.partner.miete24.com/api/webhook_endpoints' \
-H 'X-Api-Key: YOUR_API_KEY'const response = await fetch('https://sandbox.partner.miete24.com/api/webhook_endpoints', {
method: 'GET',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
},
});
const data = await response.json();Responses
| Status | Description | Schema |
|---|---|---|
| 200 | WebhookEndpoint collection | array<WebhookEndpoint-webhook_endpoint.read> |
| 403 | Forbidden | — |
POST/api/webhook_endpoints
Creates a WebhookEndpoint resource.
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| url | string|null | yes | HTTPS URL that receives event notifications via POST. |
| active | boolean | no | Whether deliveries to this endpoint are enabled. |
Example request
Example body
{
"url": "https://crm.example.com/webhooks/printer4you",
"active": true
}Code samples
curl -X POST 'https://sandbox.partner.miete24.com/api/webhook_endpoints' \
-H 'X-Api-Key: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"url":"https://crm.example.com/webhooks/printer4you","active":true}'const response = await fetch('https://sandbox.partner.miete24.com/api/webhook_endpoints', {
method: 'POST',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
'Content-Type': 'application/json',
},
body: JSON.stringify({"url":"https://crm.example.com/webhooks/printer4you","active":true}),
});
const data = await response.json();Responses
| Status | Description | Schema |
|---|---|---|
| 201 | WebhookEndpoint resource created | WebhookEndpoint.WebhookEndpointSecretResponse-webhook_endpoint.secret |
| 400 | Invalid input | — |
| 403 | Forbidden | — |
| 422 | Unprocessable entity | — |
DELETE/api/webhook_endpoints/{ulid}
Removes the WebhookEndpoint resource.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| ulid | path | string | yes | WebhookEndpoint identifier |
Code samples
curl -X DELETE 'https://sandbox.partner.miete24.com/api/webhook_endpoints/{ulid}' \
-H 'X-Api-Key: YOUR_API_KEY'const response = await fetch('https://sandbox.partner.miete24.com/api/webhook_endpoints/{ulid}', {
method: 'DELETE',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
},
});
const data = await response.json();Responses
| Status | Description | Schema |
|---|---|---|
| 204 | WebhookEndpoint resource deleted | — |
| 403 | Forbidden | — |
| 404 | Resource not found | — |
GET/api/webhook_endpoints/{ulid}
Retrieves a WebhookEndpoint resource.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| ulid | path | string | yes | WebhookEndpoint identifier |
Code samples
curl -X GET 'https://sandbox.partner.miete24.com/api/webhook_endpoints/{ulid}' \
-H 'X-Api-Key: YOUR_API_KEY'const response = await fetch('https://sandbox.partner.miete24.com/api/webhook_endpoints/{ulid}', {
method: 'GET',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
},
});
const data = await response.json();Responses
| Status | Description | Schema |
|---|---|---|
| 200 | WebhookEndpoint resource | WebhookEndpoint-webhook_endpoint.read |
| 403 | Forbidden | — |
| 404 | Resource not found | — |
PATCH/api/webhook_endpoints/{ulid}
Updates the WebhookEndpoint resource.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| ulid | path | string | yes | WebhookEndpoint identifier |
Code samples
curl -X PATCH 'https://sandbox.partner.miete24.com/api/webhook_endpoints/{ulid}' \
-H 'X-Api-Key: YOUR_API_KEY'const response = await fetch('https://sandbox.partner.miete24.com/api/webhook_endpoints/{ulid}', {
method: 'PATCH',
headers: {
'X-Api-Key': 'YOUR_API_KEY',
},
});
const data = await response.json();Responses
| Status | Description | Schema |
|---|---|---|
| 200 | WebhookEndpoint resource updated | WebhookEndpoint-webhook_endpoint.read |
| 400 | Invalid input | — |
| 403 | Forbidden | — |
| 404 | Resource not found | — |
| 422 | Unprocessable entity | — |