HOhookdeck
Connections

Create a connection

Changed on

This endpoint creates a connection. You can create a connection's underlying source, destination, and rules with a single call by declaring an object for any of those resources. You can reuse a source or destination by referencing their ID.

post/connections

Request

  • Base URL
    https://api.hookdeck.com/2025-07-01
  • Auth
    • HTTP bearer
    • or HTTP basic

Request body

namestring nullable

A unique name of the connection for the source

descriptionstring nullable

Description for the connection

destination_idstring nullable

ID of a destination to bind to the connection

source_idstring nullable

ID of a source to bind to the connection

Response

A single connection

idstring required

ID of the connection

namestring nullable required

Unique name of the connection for this source

full_namestring nullable required

Full name of the connection concatenated from source, connection and desitnation name

descriptionstring nullable required

Description of the connection

team_idstring required

ID of the project

disabled_atstring date-time nullable required

Date the connection was disabled

paused_atstring date-time nullable required

Date the connection was paused

updated_atstring date-time required

Date the connection was last updated

created_atstring date-time required

Date the connection was created

Changes

  • 9bebff6c68f9Revision changes
    • breaking

      the request property ////// became not nullable

    • breaking

      removed from the ////// request property oneOf list

    • breaking

      added subschema #4 to the ////// response property oneOf list for the response status

    • breaking

      added to the / response property oneOf list for the response status

    • breaking

      removed the required property /////// from the response with the status

    • warning

      removed the request property ///////

    • warning

      added the new SENDGRID_INBOUND enum value to the ////// response property for the response status

    • warning

      added the new SENDGRID_INBOUND enum value to the / response property for the response status

    • info

      added the new optional request property //////

    • info

      added the new SENDGRID_INBOUND enum value to the request property //////

    • info

      added the new SENDGRID_INBOUND enum value to the request property /

    • info

      added subschema #4 to the ////// request property oneOf list

    • info

      added to the / request property oneOf list

    • info

      added the optional property ////// to the response with the status

    • info

      removed from the ////// response property oneOf list for the response status

  • 8e3ce7869510Revision changes
    • breaking

      the request property ///////// became not nullable

    • breaking

      the request property /////// became not nullable

    • breaking

      the request property /////// became not nullable

    • breaking

      the request property ///////// became not nullable

    • breaking

      the request property /////// became not nullable

    • breaking

      the request property /////// became not nullable

    • breaking

      the request property /////// became required

    • breaking

      the request property /////// became required

    • breaking

      the request property /////// became required

    • breaking

      the request property /////// became required

    • breaking

      added to the ////// response property oneOf list for the response status

    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new QUO enum value to the ////// response property for the response status

    • warning

      added the new QUO enum value to the / response property for the response status

    • info

      added the new QUO enum value to the request property //////

    • info

      added the new QUO enum value to the request property /

    • info

      added to the ////// request property oneOf list

    • info

      added to the / request property oneOf list

    • info

      the response property /////// became required for the status

    • info

      the response property /////// became required for the status

    • info

      the response property /////// became required for the status

    • info

      the response property /////// became required for the status