Sign in
Integrations

Create Webhook Destination

This endpoint creates a new webhook destination. A webhook destination is a URL where webhook payloads will be sent.

post/organizations/{orgId}/integrationdestinations/webhooks

Path parameters

orgIdstring required

The unique identifier (UUID) for the organization. This specifies the organization within which the webhook destination is created.

Request body

urlstring required

The URL to which the webhook requests will be sent.

versioninteger

The version number of the entity:

  • Create entity: Not valid for initial insertion of new entity - do not use for Create. On initial Create, version is set at 1 and listed in the response.
  • Update Entity: On Update, version is required and must match the existing version because a check is performed to ensure sequential versioning is preserved. Version is incremented by 1 and listed in the response.
namestring required
descriptionstring required
codestring
activeboolean

Example request

{
  "credentials": {
    "name": "Integration Credentials",
    "apiKey": "api key",
    "secret": "api secret"
  }
}

Response

Returns the DestinationCreateRequest

urlstring

The URL to which webhook requests are sent.

idstring required

The UUID of the entity.

versioninteger

The version number:

  • Create: On initial Create to insert a new entity, the version is set at 1 in the response.
  • Update: On successful Update, the version is incremented by 1 in the response.
dtCreatedstring date-time

The DateTime when this item was created (in ISO-8601 format).

dtLastModifiedstring date-time

The DateTime when this item was last modified (in ISO-8601 format).

createdBystring

The ID of the user who created this item.

lastModifiedBystring

The ID of the user who last modified this item.

namestring
descriptionstring
codestring
activeboolean

Example response

{
  "credentials": {
    "apiKey": "api key",
    "secret": "api secret"
  }
}

Changes

Changed in 4 of the 10 revisions of this API.3112

  • ac93d1a9e6d93See the full diff
    • ○

      added the new M3TER_APP_SIGNATURE enum value to the request property credentials/allOf[IntegrationM3terSignedCredentialsRequest]/allOf[IntegrationCredentialsRequestBase]/type

      request-property-enum-value-added

    • ○

      added the new SAGE_INTACCT_CLIENT_CREDENTIALS enum value to the request property credentials/allOf[IntegrationM3terSignedCredentialsRequest]/allOf[IntegrationCredentialsRequestBase]/type

      request-property-enum-value-added

    • ○

      added the new SLACK_WEBHOOK enum value to the request property credentials/allOf[IntegrationM3terSignedCredentialsRequest]/allOf[IntegrationCredentialsRequestBase]/type

      request-property-enum-value-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 0f92c877619f4See the full diff
    • ○

      added the new HUBSPOT_ACCESS_TOKEN enum value to the request property credentials/allOf[IntegrationM3terSignedCredentialsRequest]/allOf[IntegrationCredentialsRequestBase]/type

      request-property-enum-value-added

    • ○

      added the new HUBSPOT_CLIENT_SECRET enum value to the request property credentials/allOf[IntegrationM3terSignedCredentialsRequest]/allOf[IntegrationCredentialsRequestBase]/type

      request-property-enum-value-added

    • ○

      added the new OPSGENIE_KEY enum value to the request property credentials/allOf[IntegrationM3terSignedCredentialsRequest]/allOf[IntegrationCredentialsRequestBase]/type

      request-property-enum-value-added

    • ○

      added the new SAP_BYD enum value to the request property credentials/allOf[IntegrationM3terSignedCredentialsRequest]/allOf[IntegrationCredentialsRequestBase]/type

      request-property-enum-value-added

  • 9f9e5f3dbde734See the full diff
    • ▲

      the response property credentials became optional for the status 200

      response-property-became-optional

    • ▲

      the response property url became optional for the status 200

      response-property-became-optional

    • ▲

      the url response property's minLength was decreased from 1 to 0 for the response status 200

      response-property-min-length-decreased

    • ○

      added DestinationResponse AbstractResponseWithAuditFields AbstractResponse to the response body allOf list for the response status 200

      response-body-all-of-added

    • ○

      removed DestinationRequest AbstractRequest from the response body allOf list for the response status 200

      response-body-all-of-removed

    • ○

      added IntegrationM3terSignedCredentialsResponse to the credentials response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      removed IntegrationM3terSignedCredentialsRequest from the credentials response property allOf list for the response status 200

      response-property-all-of-removed

    This revision also has 53 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9433593378b511See the full diff
    • ●

      added the new STRIPE_SIGNED_REQUEST enum value to the credentials/allOf[IntegrationM3terSignedCredentialsRequest]/allOf[IntegrationCredentialsRequestBase]/type response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new STRIPE_SIGNED_REQUEST enum value to the request property credentials/allOf[IntegrationM3terSignedCredentialsRequest]/allOf[IntegrationCredentialsRequestBase]/type

      request-property-enum-value-added

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog