Convertkit Integrations

The 9-Minute Rule for Convertkit Integrations

The 9-Minute Rule for Convertkit Integrations

e-mail – Customer e-mail address. Example demand curl class=” o” >= Example response “tags”: [“id”: 1, “name”: “Email Newsletter”, “created_at”: “2016-06-09T 17:54:22 Z”] Lists all the tags for a customer. GET/ v 3/subscribers/ # subscriber_id/ tags api_key – Your account API secret. A Broadcast is a one-time email blast that can either be sent right now or set up for a future time and date.

How Convertkit Integrations can Save You Time, Stress, and Money.What Does Convertkit Integrations Do?

GET/ v 3/broadcasts api_secret – Your API secret key. Get the stats (recipient count, open rate, click rate, unsubscribe count, overall clicks, status, send out progress) from a specific broadcast. GET/ v 3/broadcasts/ # broadcast_id/ statistics Example Demand curl class=” o” >= Example Action “broadcast”: [“id”:1, “statistics”: “recipients”: 82, “open_rate”: 60.97560975609756, “click_rate”: 23.170731707317074, “unsubscribes”: 9, “total_clicks”: 15, “show_total_clicks”: incorrect, “status”: “finished”, “development”: 100.0] api_secret – Your account API secret key.

All About Convertkit IntegrationsThe Convertkit Integrations Diaries

When a webhook is set off, a POST request will be made to your url with a JSON payload. Example demand: Create a webhook automation to receive customer information at a customer is activated. curl -X POST -H ‘Content-Type: application/json’ \ -d’ “api_secret”: “”, \ “target_url”:” “event”: “name”: “subscriber.subscriber _ trigger”‘ Example reaction “guideline”: “id”: 1, “account_id”: 2, “event”: “name”: “subscriber_activate” Example demand: Create a webhook automation to receive customer data at a series is completed.

POST/ v 3/automations/hooks api_secret – Your api secret key. target_url – The URL that will get customer data when the occasion is triggered. occasion – JSON object that includes the trigger name and extra information when needed. For example: “name”: “subscriber.subscriber _ trigger” “name”: “purchase.purchase _ produce” “name”: “subscriber.tag _ add”, “tag_id”: 4 These are the readily available occasion types: “subscriber.subscriber _ activate” “subscriber.subscriber _ unsubscribe” “subscriber.form _ subscribe”, needed parameter: form_id [Integer] “subscriber.course _ subscribe”, needed criterion: course_id [Integer] “subscriber.course _ complete”, required parameter: course_id [Integer] “subscriber.link _ click”, required specification: initiator_value [String] as a link URL “subscriber.product _ purchase”, required specification: product_id [Integer] “subscriber.tag _ include”, needed specification: tag_id [Integer] “subscriber.tag _ eliminate”, needed parameter: tag_id [Integer] “purchase.purchase _ create” Example request curl -X ERASE -H ‘Content-Type: application/json’ \ -d’ “api_secret”: “”‘ Example response “success”: true Deletes a webhook.

All About Convertkit Integrations

A custom field permits you to gather customer information beyond the basic fields of given name and email address. An example would be a custom-made field called last name so you can get the complete names of your customers. You create a customized field, and then you have the ability to use that in your kinds or with the API (see the Customers endpoint for adding custom field worths to a customer.) Note that you should create a customized field before you can utilize it with the subscribe approaches on the forms, series, and tags endpoints.

GET/ v 3/custom _ fields api_key – Your account API key. Example demand Single label curl -X POST class=” se” > \ -H ‘Content-Type: application/json’ \ -d’ “api_secret”: “”, “label”: “Occupation”‘ Numerous labels curl -X POST class=” se” > \ -H ‘Content-Type: application/json’ \ -d’ “api_secret”: “”, “label”: [” Occupation”, “Area”]’ Example response: Single custom-made field “id”: 1, “name”: “ck_field_1_occupation”, “key”: “profession”, “label”: “Occupation” Example reaction: Numerous custom fields [“id”: 1, “name”: “ck_field_1_occupation”, “essential”: “profession”, “label”: “Occupation”, “id”: 2, “name”: “ck_field_2_occupation”, “crucial”: “location”, “label”: “Location”] Create a custom-made field for your account.

Whitespace will be gotten rid of from the beginning and completion of your label. Furthermore, a key field and a name field will be generated for you. The key is an ASCII-only, lowercased, underscored representation of your label. This key should be unique to your account. Keys are utilized in personalization tags in series and broadcasts.

They are made up of a mix of ID and the secret of the customized field prefixed with “ck_field”. POST/ v 3/custom _ fields api_secret – Your api secret key. label – The label( s) of the customized field. Example request curl -X PUT class=” se” > \ -H ‘Content-Type: application/json’ \ -d’ “api_secret”: “”, “label”: “Profession”‘ Example response No material will be returned.

Examine This Report about Convertkit Integrations

Note that the key and the name do not alter even when the label is upgraded. PUT/ v 3/custom _ fields/ # your custom-made field ID api_secret – Your api secret key. id – The ID of your customized field. label – The label of the custom field. Example request curl -X DELETE class=” se” > \ -H ‘Content-Type: application/json’ \ -d’ “api_secret”: “”‘ Example response No material will be returned.

Convertkit Integrations - TruthsSee This Report about Convertkit Integrations
About Convertkit Integrations

Note that this will get rid of all data in this field from your subscribers. DELETE/ v 3/custom _ fields/ # your customized field ID api_secret – Your api secret key. id – The ID of your custom field. Example request curl class=” o” >= Example response “total_purchases”: 2, “page”: 1, “total_pages”: 1, “purchases”: [“id”: 3, “transaction_id”: “123-abcd-456-efgh”, “status”: “paid”, “email_address”: “[email protected]”, “currency”: “JPY”, “transaction_time”: “2018-03-17T 11:28:04 Z”, “subtotal”: 20.0, “shipping”: 2.0, “discount rate”: 3.0, “tax”: 2.0, “total”: 21.0, “products”: [“unit_price”: 5.0, “quantity”: 2, “sku”: “7890-ijkl”, “name”: “Floppy (512k)”, “unit_price”: 10.0, “quantity”: 1, “sku”:” mnop-1234″, “name”:” Telephone Cord (data)”], “id”: 4, “transaction_id”: “123-abcd-457-efgh”, “status”: “paid”, “email_address”: “[email protected]”, “currency”: “USD”, “transaction_time”: “2018-03-17T 11:28:04 Z”, “subtotal”: 20.0, “shipping”: 2.0, “discount rate”: 3.0, “tax”: 2.0, “total”: 21.0, “items”: [“unit_price”: 5.0, “quantity”: 2, “sku”: “7890-ijkl”, “name”: “Floppy (512k)”, “unit_price”: 10.0, “quantity”: 1, “sku”: “mnop-1234”, “name”: “Telephone Cable (information)”]] Failure response.

All about Convertkit IntegrationsOur Convertkit Integrations Ideas

page – The page of results being asked for. Default value is 1. Each page of outcomes will consist of approximately 50 purchases. Example request curl class=” o” >= Example response “id”: 8, “transaction_id”: “123-abcd-456-efgh”, “status”: “paid”, “email_address”: “[email protected]”, “currency”: “JPY”, “transaction_time”: “2018-03-17T 11:28:04 Z”, “subtotal”: 20.0, “shipping”: 2.0, “discount”: 3.0, “tax”: 2.0, “total”: 21.0, “items”: [“unit_price”: 5.0, “amount”: 2, “sku”: “7890-ijkl”, “name”: “Floppy Disk (512k)”, “unit_price”: 10.0, “quantity”: 1, “sku”: “mnop-1234”, “name”: “Telephone Cord (data)”] Failure action.

  • Form Integrations
  • Example response
  • required parameter
  • Example Request
  • Example response
  • Full Integration
  • required parameter
  • Example response
  • official integration
  • Example Request
  • Example response
  • required parameter
  • Example response
  • Integrations page
  • Example response
  • required parameter
  • mailing list
  • Example Request
  • Example response
  • required parameter
  • Example response
  • required parameter
  • Example Request
  • Example response
  • required parameter
  • Example response
  • required parameter
  • Example response
  • Example Request
  • active development
  • Example Request
  • Example response
  • underscored representationv
  • required parameter
  • Example Request
  • Example response
  • subscribable type
  • Example response
  • required parameter
  • Full Integration
  • Example Request
  • embed code
  • official integration
  • Example response
  • key/value pairs
  • required parameter
  • Subscriber Field
  • Click Save
  • Subscriber Field
  • required parameter
  • embed code
  • Example response
  • Example Request
  • left side
  • Optional parameters
  • Subscriber Field
  • required parameter
  • mailing list
  • Click Integrations
  • embed code
  • default order
  • Example response
  • required parameter
  • direct integration
  • key/value pairs
  • Subscriber Field
  • Optional parameters
  • default order
  • Example response
  • Example Request
  • required parameter
  • webhook automation
  • Optional parameters
  • Standard Builder
  • key/value pairs
  • default order
  • Example Request
  • Subscriber Field
  • required parameter
  • trigger name
  • required parameter
  • subscriber data
  • webhook automation
  • line item
  • Click Integrations
  • large integration
  • required parameter
  • Standard Builder
  • Example response
  • Subscriber Field
  • form fields
  • larger integration
  • exact same predefined options/values
  • required parameter
  • Standard Builder
  • subscriber data
  • Product variants
  • Optional parameters
  • line item
  • Example response
  • required parameter
  • Example response
  • required parameter
  • unique identifiers
  • form fields
  • subscriber data
  • Subscriber Field
  • Example Request
  • Example response
  • Optional parameters
  • response body
  • Example Request
  • subscriber data
  • response body
  • required parameter
  • line item
  • Example response
  • form fields
  • Subscriber Field
  • Optional parameters
  • subscriber data
  • specific features
  • required parameter
  • Example response
  • subscriber data
  • Optional parameters
  • Optional parameters
  • specific automations
  • Optional parameters
  • Experience Manager interface
  • API Secret section
  • required parameter
  • line item
  • latest content
  • subscriber data
  • Optional parameters
  • activate name
  • Example Request
  • exponential backoff
  • Example response
  • Example Request
  • underscored representation
  • Landing Page
  • Optional parameters
  • Optional parameters
  • required parameter
  • Example response