For the complete documentation index, see llms.txt. This page is also available as Markdown.

Outbound Webhooks

Outbound webhook subscriptions deliver Make platform events to customer-controlled HTTPS endpoints. These endpoints are proxied to the Outbound Webhooks service. Full schema documentation is available at https://github.com/integromat/outbound-webhooks/blob/master/openapi/openapi.json.

List outbound webhooks for an organization

get
/outbound-webhooks/organizations/{organizationId}/webhooks

Returns the outbound webhook subscriptions belonging to the given organization. Endpoint is proxy for the Outbound Webhooks service. Full schema documentation is available at https://github.com/integromat/outbound-webhooks/blob/master/openapi/openapi.json

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
organizationIdinteger · min: 1Required

The unique ID of the organization that owns the webhooks.

Query parameters
limitinteger · min: 1 · max: 100Optional

Maximum number of webhooks to return.

Default: 20
offsetintegerOptional

Number of webhooks to skip for pagination.

Default: 0
Responses
200

Successful response.

No content

get/outbound-webhooks/organizations/{organizationId}/webhooks

No content

Create an outbound webhook

post
/outbound-webhooks/organizations/{organizationId}/webhooks

Registers a new outbound webhook subscription for the organization. The response includes a one-time signingSecret that is not retrievable later. Endpoint is proxy for the Outbound Webhooks service. Full schema documentation is available at https://github.com/integromat/outbound-webhooks/blob/master/openapi/openapi.json

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
organizationIdinteger · min: 1Required

The unique ID of the organization that will own the webhook.

Body
namestring · min: 1 · max: 255Required

Human-readable name of the webhook.

urlstring · uriRequired

HTTPS URL that will receive webhook deliveries.

Responses
201

Webhook created.

No content

post/outbound-webhooks/organizations/{organizationId}/webhooks

No content

Get an outbound webhook

get
/outbound-webhooks/organizations/{organizationId}/webhooks/{webhookId}

Returns a single outbound webhook subscription belonging to the given organization. The signingSecret is not included in this response — it is only returned at creation time. Endpoint is proxy for the Outbound Webhooks service. Full schema documentation is available at https://github.com/integromat/outbound-webhooks/blob/master/openapi/openapi.json

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
organizationIdinteger · min: 1Required

The unique ID of the organization that owns the webhook.

webhookIdstring · uuidRequired

The unique ID of the webhook.

Responses
200

Successful response.

No content

get/outbound-webhooks/organizations/{organizationId}/webhooks/{webhookId}

No content

Delete an outbound webhook

delete
/outbound-webhooks/organizations/{organizationId}/webhooks/{webhookId}

Permanently removes an outbound webhook subscription. The webhook stops receiving deliveries immediately. Endpoint is proxy for the Outbound Webhooks service. Full schema documentation is available at https://github.com/integromat/outbound-webhooks/blob/master/openapi/openapi.json

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
organizationIdinteger · min: 1Required

The unique ID of the organization that owns the webhook.

webhookIdstring · uuidRequired

The unique ID of the webhook.

Responses
204

Webhook deleted.

No content

delete/outbound-webhooks/organizations/{organizationId}/webhooks/{webhookId}

No content

Update an outbound webhook

patch
/outbound-webhooks/organizations/{organizationId}/webhooks/{webhookId}

Updates a mutable field on an outbound webhook subscription. Only the fields provided in the request body are changed. Endpoint is proxy for the Outbound Webhooks service. Full schema documentation is available at https://github.com/integromat/outbound-webhooks/blob/master/openapi/openapi.json

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
organizationIdinteger · min: 1Required

The unique ID of the organization that owns the webhook.

webhookIdstring · uuidRequired

The unique ID of the webhook.

Body
namestring · min: 1 · max: 255Optional

Human-readable name of the webhook.

urlstring · uriOptional

HTTPS URL that will receive webhook deliveries.

Responses
200

Webhook updated.

No content

patch/outbound-webhooks/organizations/{organizationId}/webhooks/{webhookId}

No content

Activate an outbound webhook

patch
/outbound-webhooks/organizations/{organizationId}/webhooks/{webhookId}/activate

Activates a previously paused outbound webhook subscription. The webhook's status becomes live on success. Endpoint is proxy for the Outbound Webhooks service. Full schema documentation is available at https://github.com/integromat/outbound-webhooks/blob/master/openapi/openapi.json

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
organizationIdinteger · min: 1Required

The unique ID of the organization that owns the webhook.

webhookIdstring · uuidRequired

The unique ID of the webhook.

Responses
200

Webhook activated.

No content

patch/outbound-webhooks/organizations/{organizationId}/webhooks/{webhookId}/activate

No content

Deactivate an outbound webhook

patch
/outbound-webhooks/organizations/{organizationId}/webhooks/{webhookId}/deactivate

Pauses an outbound webhook subscription. The webhook's status becomes paused on success and deliveries stop until the webhook is activated again. Endpoint is proxy for the Outbound Webhooks service. Full schema documentation is available at https://github.com/integromat/outbound-webhooks/blob/master/openapi/openapi.json

Required scopes
This endpoint requires the following scopes:
Authorizations
AuthorizationstringRequired

Authorize the API call with your API token in the Authorization header with the value: Token your-api-token.

If you don't have an API token yet, please refer to the "Authentication" section to learn how to create one.

Path parameters
organizationIdinteger · min: 1Required

The unique ID of the organization that owns the webhook.

webhookIdstring · uuidRequired

The unique ID of the webhook.

Responses
200

Webhook deactivated.

No content

patch/outbound-webhooks/organizations/{organizationId}/webhooks/{webhookId}/deactivate

No content

Last updated