POST v3/webhooks

POST 
/v3/webhooks

Register a webhook to receive events at your own URL.

The POST v3/webhooks endpoint allows for registering a new webhook to an specific eventType of a specific entityType.

Including related resources

There are currently no resources to be included in the request or response.

Limitations of POST v3/webhooks

• Only valid entity and event pairs are supported, see the definition of webhookEvent.

Request

Responses

201

Created

400

400 Bad Request

A 400 Bad Request response indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax, invalid request message framing, or deceptive request routing).

The following are common scenarios that may lead to a 400 Bad Request response:

• Malformed syntax, for example when the request does not follow the expected syntax or structure.
• Invalid parameters included or unsupported parameters in the request.
• Missing or incomplete information that is required by the server to process the request successfully
• Request size limitations when the message exceeds the size limits set by the server.
• URL encoding issues, usually for query parameters in the request that contain characters that are not properly encoded.
• Server-side validation failures when the server determines that the request is invalid based on its business logic and business rules. In such cases, the server responds with a 400 error along with additional information explaining the validation failure.

401

401 Unauthorized

A 401 Unauthorized response occurs when attempting to access a resource or perform an action that requires authentication, but no valid credentials have been provided. It indicates that the requester is unauthorized to access the requested resource.

The following are common scenarios that may lead to a 401 Unauthorized response:

• Attempting to access a protected API endpoint without providing authentication credentials.
• Providing an invalid or expired authentication token.
• Providing valid authentication credentials, but lacking sufficient privileges to access the requested resource.
• Providing authentication credentials that are valid for a different resource or API endpoint than the one being requested.

403

403 Forbidden

The HTTP 403 Forbidden client error response status code indicates that the server understood the request but refused to process it. This status is similar to 401 Unauthorized, except that for 403 Forbidden responses, authenticating or re-authenticating makes no difference. The request failure is tied to application logic, such as insufficient permissions to a resource or action.

406

406 Not Acceptable

A 406 Not Acceptable response occurs when the server cannot provide a response that matches the client's requested format or content language for the requested resource. For instance, if a client sends an Accept header of text/html to an API endpoint that only supports application/json responses, the server would respond with a 406 Not Acceptable status code. This type of response is a required response for JSON:API compatible endpoints.

415

415 Unsupported Media Type

A 415 Unsupported Media Type response occurs when the server cannot process the request because the media type specified in the request is not supported for the requested resource. For example, if a client sends a request with a Content-Type header of application/pdf to an API endpoint that only supports application/json (the only valid media type for JSON:API), the server would respond with a 415 Unsupported Media Type status code. This type of error-response is a required for JSON:API compatible endpoints.